PHP Class AppserverIo\Appserver\Application\ApplicationStateKeys

See link: https://github.com/appserver-io/appserver
See link: http://www.appserver.io
Author: Tim Wagner ([email protected])
Show file Open project: appserver-io/appserver Class Usage Examples

Public Methods

Method Description
__toString ( ) : string Returns the application state representation as string.
equals ( ApplicationStateKeys $applicationState ) : boolean Returns TRUE if the passed application state equals the actual one, else FALSE.
get ( integer $applicationState ) : ApplicationStateKeys Factory method to create a new application state instance.
getApplicationState ( ) : integer Returns the application state representation as integer.
getApplicationStates ( ) : array Returns the container states.
greaterOrEqualThan ( ApplicationStateKeys $containerState ) : boolean Returns TRUE if the container state is greater than the passed one, else FALSE.
notEquals ( ApplicationStateKeys $applicationState ) : boolean Returns TRUE if the passed application state NOT equals the actual one, else FALSE.

Private Methods

Method Description
__clone ( ) : void This is a utility class, so protect it against cloning.
__construct ( integer $applicationState ) This is a utility class, so protect it against direct instantiation.

Method Details

__toString() public method

Returns the application state representation as string.
See also: AppserverIo\Appserver\Core\Utilities\ApplicationStateKeys::getApplicationState()
public __toString ( ) : string
return string The string representation of the application state

equals() public method

Returns TRUE if the passed application state equals the actual one, else FALSE.
public equals ( ApplicationStateKeys $applicationState ) : boolean
$applicationState ApplicationStateKeys The container state to check
return boolean TRUE if equal, else FALSE

get() public static method

Factory method to create a new application state instance.
public static get ( integer $applicationState ) : ApplicationStateKeys
$applicationState integer The application state to create an instance for
return ApplicationStateKeys The application state key instance

getApplicationState() public method

Returns the application state representation as integer.
public getApplicationState ( ) : integer
return integer The integer representation of the application state

getApplicationStates() public static method

Returns the container states.
public static getApplicationStates ( ) : array
return array The container states

greaterOrEqualThan() public method

Returns TRUE if the container state is greater than the passed one, else FALSE.
public greaterOrEqualThan ( ApplicationStateKeys $containerState ) : boolean
$containerState ApplicationStateKeys The container state to be greater than
return boolean TRUE if equal, else FALSE

notEquals() public method

Returns TRUE if the passed application state NOT equals the actual one, else FALSE.
public notEquals ( ApplicationStateKeys $applicationState ) : boolean
$applicationState ApplicationStateKeys The container state to check NOT to be equal
return boolean TRUE if NOT equal, else FALSE