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

См. ссылку: https://github.com/appserver-io/appserver
См. ссылку: http://www.appserver.io
Автор: Tim Wagner ([email protected])
Автор: Johann Zelger ([email protected])
Наследование: extends AppserverIo\Description\Api\Node\AbstractNode, use trait AppserverIo\Appserver\Core\Api\Node\ClassLoadersNodeTrait, use trait LoggersNodeTrait, use trait ManagersNodeTrait, use trait AppserverIo\Appserver\Core\Api\Node\ProvisionersNodeTrait, use trait ParamsNodeTrait
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$environmentName string The application environment
$factory string The context factory class name.
$name string The context name.
$type string The context type.
$webappPath string The path to the web application.

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

Метод Описание
__construct ( string $name = '', string $type = '', string $factory = '', array $params = [], string $webappPath = '' ) Initializes the context configuration with the passed values.
getEnvironmentName ( ) : string Returns the environment name of the application
getFactory ( ) : ApplicationFactory Returns the context factory class name.
getName ( ) : mixed Returns the context name.
getType ( ) : string | null Returns the context type.
getWebappPath ( ) : string Returns the path to the web application.
initDefaultDirectories ( ) : void Initialize the default directories.
merge ( ContextNode $contextNode ) : void This method merges the installation steps of the passed provisioning node into the steps of this instance. If a installation node with the same type already exists, the one of this instance will be overwritten.
setEnvironmentName ( string $environmentName ) : void Setter for the environment name
setFactory ( string $factory ) : void Sets the context factory class name.
setName ( string $name ) : void Sets the context name.
setType ( string $type ) : void Sets the context type.
setWebappPath ( string $webappPath ) : void Set's the path to the web application.

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

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

Initializes the context configuration with the passed values.
public __construct ( string $name = '', string $type = '', string $factory = '', array $params = [], string $webappPath = '' )
$name string The context name
$type string The context class name
$factory string The context factory class name
$params array The context params
$webappPath string The path to the web application

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

Returns the environment name of the application
public getEnvironmentName ( ) : string
Результат string

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

Returns the context factory class name.
public getFactory ( ) : ApplicationFactory
Результат AppserverIo\Appserver\Application\ApplicationFactory

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

Returns the context name.
public getName ( ) : mixed
Результат mixed

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

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

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

Returns the path to the web application.
public getWebappPath ( ) : string
Результат string

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

Initialize the default directories.
public initDefaultDirectories ( ) : void
Результат void

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

This method merges the installation steps of the passed provisioning node into the steps of this instance. If a installation node with the same type already exists, the one of this instance will be overwritten.
public merge ( ContextNode $contextNode ) : void
$contextNode ContextNode The node with the installation steps we want to merge
Результат void

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

Setter for the environment name
public setEnvironmentName ( string $environmentName ) : void
$environmentName string The environment name to set
Результат void

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

Sets the context factory class name.
public setFactory ( string $factory ) : void
$factory string The context factory class name
Результат void

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

Sets the context name.
public setName ( string $name ) : void
$name string The context name
Результат void

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

Sets the context type.
public setType ( string $type ) : void
$type string The context type
Результат void

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

Set's the path to the web application.
public setWebappPath ( string $webappPath ) : void
$webappPath string The path to the web application
Результат void

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

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

The application environment
protected string $environmentName
Результат string

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

The context factory class name.
protected string $factory
Результат string

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

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

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

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

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

The path to the web application.
protected string $webappPath
Результат string