Zend\Server\Method\Parameter
Method parameter metadata
Synopsis
class Parameter
{
- // members
- protected mixed $defaultValue;
- protected string $description;
- protected string $name;
- protected bool $optional;
- protected string $type;
- // methods
- public void __construct()
- public Parameter setOptions()
- public Parameter setDefaultValue()
- public mixed getDefaultValue()
- public Parameter setDescription()
- public string getDescription()
- public Parameter setName()
- public string getName()
- public Parameter setOptional()
- public bool isOptional()
- public Parameter setType()
- public string getType()
- public array toArray()
Members
protected
- $defaultValue
—
mixed
Default parameter value - $description
—
string
Parameter description - $name
—
string
Parameter variable name - $optional
—
Zend\Server\Method\bool
Is parameter optional? - $type
—
string
Parameter type
Methods
public
- __construct() — Constructor
- getDefaultValue() — Retrieve default value
- getDescription() — Retrieve description
- getName() — Retrieve name
- getType() — Retrieve parameter type
- isOptional() — Is the parameter optional?
- setDefaultValue() — Set default value
- setDescription() — Set description
- setName() — Set name
- setOptional() — Set optional flag
- setOptions() — Set object state from array of options
- setType() — Set parameter type
- toArray() — Cast to array