PHP Интерфейс gossi\codegen\model\RoutineInterface

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

Метод	Описание
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
getBody ( ) : string	Returns the body
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
isReferenceReturned ( ) : boolean	Returns whether a reference is returned
removeParameter ( integer \| string \| PhpParameter $param )	Remove a parameter at a given position
replaceParameter ( integer $position, PhpParameter $parameter )	Replaces a parameter at a given position
setBody ( string $body )	Sets the body for this
setParameters ( array $parameters )	Sets a collection of parameters
setReferenceReturned ( boolean $bool )	Set true if a reference is returned of false if not

Adds a parameter

public addParameter ( PhpParameter $parameter )
$parameter	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

Returns the body

public getBody ( ) : string
Результат	string

Returns a parameter by index or name

public getParameter ( string \| integer $nameOrIndex ) : PhpParameter
$nameOrIndex	string \| integer
Результат	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

Returns whether a reference is returned

public isReferenceReturned ( ) : boolean
Результат	boolean

Remove a parameter at a given position

public removeParameter ( integer \| string \| PhpParameter $param )
$param	integer \| string \| PhpParameter

Replaces a parameter at a given position

public replaceParameter ( integer $position, PhpParameter $parameter )
$position	integer
$parameter	PhpParameter

Sets the body for this

public setBody ( string $body )
$body	string

Note: clears all parameters before setting the new ones

public setParameters ( array $parameters )
$parameters	array

Set true if a reference is returned of false if not

public setReferenceReturned ( boolean $bool )
$bool	boolean