PHP Трейт gossi\codegen\model\parts\ParametersPart

For all models that can have parameters

Автор: Thomas Gossmann

Открытые методы

Метод	Описание
addParameter ( PhpParameter $parameter )	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 ) : PhpParameter	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 \| PhpParameter $param )	Remove a parameter at a given position
replaceParameter ( integer $position, PhpParameter $parameter )	Replaces a parameter at a given position
setParameters ( array $parameters )	Sets a collection of parameters

Метод	Описание
generateParamDocblock ( )	Generates docblock for params
getDocblock ( ) : Docblock	Returns the docblock

Метод	Описание
checkPosition ( $position )
initParameters ( )
removeParameterByName ( $name )
removeParameterByPosition ( $position )

Adds a parameter

public addParameter ( PhpParameter $parameter )
$parameter	gossi\codegen\model\PhpParameter

A quick way to add a parameter with description which is created from the given parameters

public addSimpleDescParameter ( string $name, null \| string $type = null, null \| string $typeDescription = null, mixed $defaultValue = null )
$name	string
$type	null \| string
$typeDescription	null \| string
$defaultValue	mixed	omit the argument to define no default value

A quick way to add a parameter which is created from the given parameters

public addSimpleParameter ( string $name, null \| string $type = null, mixed $defaultValue = null )
$name	string
$type	null \| string
$defaultValue	mixed	omit the argument to define no default value

Generates docblock for params

protected generateParamDocblock ( )

Returns the docblock

abstract protected getDocblock ( ) : Docblock
Результат	Docblock

Returns a parameter by index or name

public getParameter ( string \| integer $nameOrIndex ) : PhpParameter
$nameOrIndex	string \| integer
Результат	gossi\codegen\model\PhpParameter

Returns a collection of parameters

public getParameters ( ) : array
Результат	array

Checks whether a parameter exists

public hasParameter ( string $name ) : boolean
$name	string	parameter name
Результат	boolean	`true` if a parameter exists and `false` if not

Remove a parameter at a given position

public removeParameter ( integer \| string \| PhpParameter $param )
$param	integer \| string \| gossi\codegen\model\PhpParameter

Replaces a parameter at a given position

public replaceParameter ( integer $position, PhpParameter $parameter )
$position	integer
$parameter	gossi\codegen\model\PhpParameter

Note: clears all parameters before setting the new ones

public setParameters ( array $parameters )
$parameters	array