PHP Class AppserverIo\Appserver\Core\Api\Node\ContextNode

See link: https://github.com/appserver-io/appserver
See link: http://www.appserver.io
Author: Tim Wagner ([email protected])
Author: Johann Zelger ([email protected])
Inheritance: 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
Show file Open project: appserver-io/appserver Class Usage Examples

Protected Properties

Property Type Description
$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.

Public Methods

Method Description
__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.

Method Details

__construct() public method

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() public method

Returns the environment name of the application
public getEnvironmentName ( ) : string
return string

getFactory() public method

Returns the context factory class name.
public getFactory ( ) : ApplicationFactory
return AppserverIo\Appserver\Application\ApplicationFactory

getName() public method

Returns the context name.
public getName ( ) : mixed
return mixed

getType() public method

Returns the context type.
public getType ( ) : string | null
return string | null The context type

getWebappPath() public method

Returns the path to the web application.
public getWebappPath ( ) : string
return string

initDefaultDirectories() public method

Initialize the default directories.
public initDefaultDirectories ( ) : void
return void

merge() public method

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
return void

setEnvironmentName() public method

Setter for the environment name
public setEnvironmentName ( string $environmentName ) : void
$environmentName string The environment name to set
return void

setFactory() public method

Sets the context factory class name.
public setFactory ( string $factory ) : void
$factory string The context factory class name
return void

setName() public method

Sets the context name.
public setName ( string $name ) : void
$name string The context name
return void

setType() public method

Sets the context type.
public setType ( string $type ) : void
$type string The context type
return void

setWebappPath() public method

Set's the path to the web application.
public setWebappPath ( string $webappPath ) : void
$webappPath string The path to the web application
return void

Property Details

$environmentName protected property

The application environment
protected string $environmentName
return string

$factory protected property

The context factory class name.
protected string $factory
return string

$name protected property

The context name.
protected string $name
return string

$type protected property

The context type.
protected string $type
return string

$webappPath protected property

The path to the web application.
protected string $webappPath
return string