Method | Description | |
---|---|---|
addParameter ( |
Adds a parameter | |
addSimpleDescParameter ( string $name, null | string $type = null, null | string $typeDescription = null, mixed $defaultValue = null ) | A quick way to add a parameter with description which is created from the given parameters | |
addSimpleParameter ( string $name, null | string $type = null, mixed $defaultValue = null ) | A quick way to add a parameter which is created from the given parameters | |
getParameter ( string | integer $nameOrIndex ) : |
Returns a parameter by index or name | |
getParameters ( ) : array | Returns a collection of parameters | |
hasParameter ( string $name ) : boolean | Checks whether a parameter exists | |
removeParameter ( integer | string | |
Remove a parameter at a given position | |
replaceParameter ( integer $position, |
Replaces a parameter at a given position | |
setParameters ( array $parameters ) | Sets a collection of parameters |
Method | Description | |
---|---|---|
generateParamDocblock ( ) | Generates docblock for params | |
getDocblock ( ) : Docblock | Returns the docblock |
Method | Description | |
---|---|---|
checkPosition ( $position ) | ||
initParameters ( ) | ||
removeParameterByName ( $name ) | ||
removeParameterByPosition ( $position ) |
public addParameter ( |
||
$parameter |
protected generateParamDocblock ( ) |
abstract protected getDocblock ( ) : Docblock | ||
return | Docblock |
public getParameter ( string | integer $nameOrIndex ) : |
||
$nameOrIndex | string | integer | |
return |
public getParameters ( ) : array | ||
return | array |
public hasParameter ( string $name ) : boolean | ||
$name | string | parameter name |
return | boolean | `true` if a parameter exists and `false` if not |
public removeParameter ( integer | string | |
||
$param | integer | string | |
public replaceParameter ( integer $position, |
||
$position | integer | |
$parameter |
public setParameters ( array $parameters ) | ||
$parameters | array |