Parameter Class Reference

Represent a parameter for a command. More...

Public Member Functions
	__construct (string $name='', string $description='', array $values=[], string $defaultValue="")
	__toString ()
	getName ()
	setName ($name)
	getDescription ()
	setDescription ($description)
	getValues ()
	setValues ($values)
	getDefaultValue ()
	setDefaultValue ($defaultValue)

Static Public Member Functions
static	create (string $name, string $description, array $values, string $defaultValue="")
	Return a new parameter.

Protected Attributes
	$name
	$description
	$values
	$defaultValue

Detailed Description

Represent a parameter for a command.

Ubiquity\devtools\cmd$Parameter This class is part of Ubiquity

Author

jc

Version

1.0.0

Definition at line 13 of file Parameter.php.

Constructor & Destructor Documentation

__construct()

__construct	(	string	$name = '',
		string	$description = '',
		array	$values = [],
		string	$defaultValue = ""
	)

Definition at line 23 of file Parameter.php.

Member Function Documentation

__toString()

__toString

(

)

Definition at line 30 of file Parameter.php.

create()

static create ( string  $name, string  $description, array  $values, string  $defaultValue = ""  )

static

Return a new parameter.

Parameters

string	$name	The parameter name
string	$description	The parameter description
array	$values	The possible values
string	$defaultValue	The default value

Returns

\Ubiquity\devtools\cmd\Parameter

Definition at line 92 of file Parameter.php.

getDefaultValue()

getDefaultValue

(

)

Definition at line 70 of file Parameter.php.

getDescription()

getDescription

(

)

Definition at line 52 of file Parameter.php.

getName()

getName

(

)

Definition at line 43 of file Parameter.php.

getValues()

getValues

(

)

Definition at line 61 of file Parameter.php.

setDefaultValue()

setDefaultValue

(

$defaultValue

)

Definition at line 74 of file Parameter.php.

setDescription()

setDescription

(

$description

)

Definition at line 56 of file Parameter.php.

setName()

setName

(

$name

)

Definition at line 47 of file Parameter.php.

setValues()

setValues

(

$values

)

Definition at line 65 of file Parameter.php.

Field Documentation

$defaultValue

$defaultValue

protected

Definition at line 21 of file Parameter.php.

$description

$description

protected

Definition at line 17 of file Parameter.php.

$name

$name

protected

Definition at line 15 of file Parameter.php.

$values

$values

protected

Definition at line 19 of file Parameter.php.

---

The documentation for this class was generated from the following file:

• C:/Users/myadd/Documents/GitHub/ubiquity-doc-api/vendor/phpmv/ubiquity-commands/src/Ubiquity/devtools/cmd/Parameter.php