PHP Класс gossi\codegen\model\PhpParameter

Автор: Johannes M. Schmitt ([email protected])
Наследование: extends AbstractModel, use trait gossi\codegen\model\parts\NameTrait, use trait gossi\codegen\model\parts\DefaultValueTrait, use trait gossi\codegen\model\parts\TypeTrait
Показать файл Открыть проект Примеры использования класса

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

Метод Описание
__construct ( string $name = null ) Creates a new PHP parameter
create ( string $name = null ) : static Creates a new PHP parameter.
fromReflection ( ReflectionParameter $ref ) : PhpParameter Creates a PHP parameter from reflection
getDocblockTag ( ) : gossi\docblock\tags\ParamTag Returns a docblock tag for this parameter
getTypeDescription ( ) : string Alias for getDescription()
isPassedByReference ( ) : boolean Returns whether this parameter is passed by reference
setPassedByReference ( boolean $bool ) Sets whether this parameter is passed by reference
setTypeDescription ( string $description ) Alias for setDescription()

Описание методов

__construct() публичный Метод

Creates a new PHP parameter
public __construct ( string $name = null )
$name string the parameter name

create() публичный статический Метод

Creates a new PHP parameter.
public static create ( string $name = null ) : static
$name string the parameter name
Результат static

fromReflection() публичный статический Метод

Creates a PHP parameter from reflection
Устаревший: will be removed in version 0.5
public static fromReflection ( ReflectionParameter $ref ) : PhpParameter
$ref ReflectionParameter
Результат PhpParameter

getDocblockTag() публичный Метод

Returns a docblock tag for this parameter
public getDocblockTag ( ) : gossi\docblock\tags\ParamTag
Результат gossi\docblock\tags\ParamTag

getTypeDescription() публичный Метод

Alias for getDescription()
public getTypeDescription ( ) : string
Результат string

isPassedByReference() публичный Метод

Returns whether this parameter is passed by reference
public isPassedByReference ( ) : boolean
Результат boolean `true` if passed by reference and `false` if not

setPassedByReference() публичный Метод

Sets whether this parameter is passed by reference
public setPassedByReference ( boolean $bool )
$bool boolean `true` if passed by reference and `false` if not

setTypeDescription() публичный Метод

Alias for setDescription()
public setTypeDescription ( string $description )
$description string