PHP Класс AppserverIo\Appserver\Core\Api\Node\ParamNode

Автор: Tim Wagner ([email protected])
Наследование: extends AppserverIo\Description\Api\Node\AbstractValueNode
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$constant string TRUE if the value is a constant.
$env string TRUE if the value is an environment variable.
$name string The paramss name.
$type string The params data type.

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

Метод Описание
__construct ( string $name = '', string $type = '', AppserverIo\Configuration\Interfaces\ValueInterface $nodeValue = null, boolean $constant = false, boolean $env = false ) Initializes the param node with the necessary data.
castToType ( ) : mixed Casts the params value to the defined type and returns it.
getName ( ) : string Returns the param name.
getPrimaryKey ( ) : string Returns the nodes primary key, the name by default.
getType ( ) : string Returns the param type.
isConstant ( ) : boolean Returns the TRUE if the value is a constant, else FALSE.
isEnv ( ) : boolean Returns the TRUE if the value is an environment variable, else FALSE.

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

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

Initializes the param node with the necessary data.
public __construct ( string $name = '', string $type = '', AppserverIo\Configuration\Interfaces\ValueInterface $nodeValue = null, boolean $constant = false, boolean $env = false )
$name string The params name
$type string The params data type
$nodeValue AppserverIo\Configuration\Interfaces\ValueInterface The params initial value
$constant boolean TRUE if the value is a constant, else FALSE
$env boolean TRUE if the value is an environment variable, else FALSE

castToType() публичный метод

Casts the params value to the defined type and returns it.
public castToType ( ) : mixed
Результат mixed The casted value

getName() публичный метод

Returns the param name.
public getName ( ) : string
Результат string The param name

getPrimaryKey() публичный метод

Returns the nodes primary key, the name by default.
См. также: AppserverIo\Appserver\Core\Api\Node\AbstractNode::getPrimaryKey()
public getPrimaryKey ( ) : string
Результат string The nodes primary key

getType() публичный метод

Returns the param type.
public getType ( ) : string
Результат string The param type

isConstant() публичный метод

Returns the TRUE if the value is a constant, else FALSE.
public isConstant ( ) : boolean
Результат boolean TRUE if the value is a constant, else FALSE

isEnv() публичный метод

Returns the TRUE if the value is an environment variable, else FALSE.
public isEnv ( ) : boolean
Результат boolean TRUE if the value is an environment variable, else FALSE

Описание свойств

$constant защищенное свойство

TRUE if the value is a constant.
protected string $constant
Результат string

$env защищенное свойство

TRUE if the value is an environment variable.
protected string $env
Результат string

$name защищенное свойство

The paramss name.
protected string $name
Результат string

$type защищенное свойство

The params data type.
protected string $type
Результат string