[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/vendor/symfony/console/Input/ -> InputArgument.php (summary)

(no description)

File Size: 129 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

InputArgument:: (7 methods):
  __construct()
  getName()
  isRequired()
  isArray()
  setDefault()
  getDefault()
  getDescription()


Class: InputArgument  - X-Ref

Represents a command line argument.

__construct(string $name, int $mode = null, string $description = '', $default = null)   X-Ref

param: string                           $name        The argument name
param: int|null                         $mode        The argument mode: self::REQUIRED or self::OPTIONAL
param: string                           $description A description text
param: string|bool|int|float|array|null $default     The default value (for self::OPTIONAL mode only)

getName()   X-Ref
Returns the argument name.

return: string

isRequired()   X-Ref
Returns true if the argument is required.

return: bool true if parameter mode is self::REQUIRED, false otherwise

isArray()   X-Ref
Returns true if the argument can take multiple values.

return: bool true if mode is self::IS_ARRAY, false otherwise

setDefault($default = null)   X-Ref
Sets the default value.

param: string|bool|int|float|array|null $default

getDefault()   X-Ref
Returns the default value.

return: string|bool|int|float|array|null

getDescription()   X-Ref
Returns the description text.

return: string



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer