Function __global->do_command_help

Definitions

sources/commandr.php

  • Template for a command's help.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$command string No No required parameter N/A N/A Command name
$options array No No required parameter N/A N/A Options
$parameters array No No required parameter N/A N/A Parameters (keys are the parameters, values are always set to true, i.e. it is an array of as many trues as there are parameters)

Returns

  • Help template
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Template for a command's help.
 *
 * @param  string $command Command name
 * @param  array $options Options
 * @param  array $parameters Parameters (keys are the parameters, values are always set to true, i.e. it is an array of as many trues as there are parameters)
 * @return Tempcode Help template
 */
function do_command_help(string $command, array $options, array $parameters) : object