PHP Interface AppserverIo\Appserver\Core\Api\Node\VirtualHostNodeInterface

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\Configuration\Interfaces\NodeInterface
Show file Open project: appserver-io/appserver Interface Usage Examples

Public Methods

Method Description
getAccesses ( ) : array Will return access definitions
getAccessesAsArray ( ) : array Returns the rewrites as an associative array.
getAnalytic ( string $uri ) : AnalyticNode | boolean Will return the analytic node with the specified definition and if nothing could be found we will return false
getAnalytics ( ) : array Will return the analytics array
getAnalyticsAsArray ( ) : array Returns the analytics as an associative array
getAuthentication ( string $uri ) : AuthenticationNode | boolean Will return the authentication node with the specified definition and if nothing could be found we will return false.
getAuthentications ( ) : array Will return the authentications array.
getAuthenticationsAsArray ( ) : array Returns the authentications as an associative array.
getEnvironmentVariable ( string $definition ) : EnvironmentVariableNode | boolean Will return the environmentVariable node with the specified definition and if nothing could be found we will return false.
getEnvironmentVariables ( ) : array Will return the environment variables array.
getEnvironmentVariablesAsArray ( ) : array Returns the environmentVariables as an associative array.
getExtensionType ( ) : string Getter for extensionType attribute
getHeaders ( ) : array Returns the file headers nodes.
getHeadersAsArray ( ) : array Returns the headers as an associative array.
getInjection ( ) : mixed Will return the data the defined injector creates
getInjector ( ) : AppserverIo\Server\Configuration\Extension\InjectorInterface Getter for the injector, will lazy-init it
getLocation ( string $condition ) : LocationNode | boolean Will return the location node with the specified condition and if nothing could be found we will return false.
getLocations ( ) : array Will return the locations array.
getLocationsAsArray ( ) : array Returns the locations as an associative array.
getName ( ) : string Returns the virtual hosts name
getParam ( string $name ) : mixed Returns the param with the passed name casted to the specified type.
getParamsAsArray ( ) : array Returns the params casted to the defined type as associative array.
getRewrite ( string $condition ) : RewriteNode | boolean Will return the rewrite node with the specified condition and if nothing could be found we will return false.
getRewriteMaps ( ) : array Will return rewriteMaps definitions
getRewriteMapsAsArray ( ) : array Returns the rewriteMaps as an associative array.
getRewrites ( ) : array Will return the rewrites array.
getRewritesAsArray ( ) : array Returns the rewrites as an associative array.
hasInjector ( ) : boolean Will return true if the class has a filled extensionType attribute and therefor an injector

Method Details

getAccesses() public method

Will return access definitions
public getAccesses ( ) : array
return array

getAccessesAsArray() public method

Returns the rewrites as an associative array.
public getAccessesAsArray ( ) : array
return array The array with the sorted rewrites

getAnalytic() public method

Will return the analytic node with the specified definition and if nothing could be found we will return false
public getAnalytic ( string $uri ) : AnalyticNode | boolean
$uri string The URI of the analytic in question
return AnalyticNode | boolean The requested analytics node

getAnalytics() public method

Will return the analytics array
public getAnalytics ( ) : array
return array The array with the analytic nodes

getAnalyticsAsArray() public method

Returns the analytics as an associative array
public getAnalyticsAsArray ( ) : array
return array The array with the sorted analytics

getAuthentication() public method

Will return the authentication node with the specified definition and if nothing could be found we will return false.
public getAuthentication ( string $uri ) : AuthenticationNode | boolean
$uri string The URI of the authentication in question
return AuthenticationNode | boolean The requested authentication node

getAuthentications() public method

Will return the authentications array.
public getAuthentications ( ) : array
return array The array with the authentications

getAuthenticationsAsArray() public method

Returns the authentications as an associative array.
public getAuthenticationsAsArray ( ) : array
return array The array with the sorted authentications

getEnvironmentVariable() public method

Will return the environmentVariable node with the specified definition and if nothing could be found we will return false.
public getEnvironmentVariable ( string $definition ) : EnvironmentVariableNode | boolean
$definition string The definition of the environmentVariable in question
return EnvironmentVariableNode | boolean The requested environmentVariable node

getEnvironmentVariables() public method

Will return the environment variables array.
public getEnvironmentVariables ( ) : array
return array The array with the environment variables

getEnvironmentVariablesAsArray() public method

Returns the environmentVariables as an associative array.
public getEnvironmentVariablesAsArray ( ) : array
return array The array with the sorted environmentVariables

getExtensionType() public method

Getter for extensionType attribute
public getExtensionType ( ) : string
return string

getHeaders() public method

Returns the file headers nodes.
public getHeaders ( ) : array
return array

getHeadersAsArray() public method

Returns the headers as an associative array.
public getHeadersAsArray ( ) : array
return array The array with the headers

getInjection() public method

Will return the data the defined injector creates
public getInjection ( ) : mixed
return mixed

getInjector() public method

Getter for the injector, will lazy-init it
public getInjector ( ) : AppserverIo\Server\Configuration\Extension\InjectorInterface
return AppserverIo\Server\Configuration\Extension\InjectorInterface

getLocation() public method

Will return the location node with the specified condition and if nothing could be found we will return false.
public getLocation ( string $condition ) : LocationNode | boolean
$condition string The condition of the location in question
return LocationNode | boolean The requested location node

getLocations() public method

Will return the locations array.
public getLocations ( ) : array
return array

getLocationsAsArray() public method

Returns the locations as an associative array.
public getLocationsAsArray ( ) : array
return array The array with the sorted locations

getName() public method

Returns the virtual hosts name
public getName ( ) : string
return string The server's type

getParam() public method

Returns the param with the passed name casted to the specified type.
public getParam ( string $name ) : mixed
$name string The name of the param to be returned
return mixed The requested param casted to the specified type

getParamsAsArray() public method

Returns the params casted to the defined type as associative array.
public getParamsAsArray ( ) : array
return array The array with the casted params

getRewrite() public method

Will return the rewrite node with the specified condition and if nothing could be found we will return false.
public getRewrite ( string $condition ) : RewriteNode | boolean
$condition string The condition of the rewrite in question
return RewriteNode | boolean The requested rewrite node

getRewriteMaps() public method

Will return rewriteMaps definitions
public getRewriteMaps ( ) : array
return array

getRewriteMapsAsArray() public method

Returns the rewriteMaps as an associative array.
public getRewriteMapsAsArray ( ) : array
return array The array with the rewriteMaps

getRewrites() public method

Will return the rewrites array.
public getRewrites ( ) : array
return array

getRewritesAsArray() public method

Returns the rewrites as an associative array.
public getRewritesAsArray ( ) : array
return array The array with the sorted rewrites

hasInjector() public method

Will return true if the class has a filled extensionType attribute and therefor an injector
public hasInjector ( ) : boolean
return boolean