PHP Class Vinelab\Minion\Minion

Author: Abed Halawi ([email protected])
Datei anzeigen Open project: vinelab/minion Class Usage Examples

Public Methods

Method Description
getConfig ( string $option = null ) : mixed Get all configuration params or specify a given option.
getRegisteredProviders ( ) : array Get all the currently registered providers.
gimmeASCII ( ) : string Get the ASCII drawing of Dave the minion.
mergeConfig ( array $options ) Merge the current configuration with the given options.
newClient ( ) : Client Get a new Client instance.
newTransportProvider ( ) : Thruway\Transport\PawlTransportProvider Get a new transport provider instance.
register ( Closur\Closure | string $provider ) Register the given provider.
run ( array $options = [] ) Run the server.
transportUrl ( ) : string Get the transport URL that provider should connect to.

Method Details

getConfig() public method

Get all configuration params or specify a given option.
public getConfig ( string $option = null ) : mixed
$option string
return mixed

getRegisteredProviders() public method

Get all the currently registered providers.
public getRegisteredProviders ( ) : array
return array

gimmeASCII() public method

Get the ASCII drawing of Dave the minion.
public gimmeASCII ( ) : string
return string

mergeConfig() public method

Merge the current configuration with the given options.
public mergeConfig ( array $options )
$options array

newClient() public method

Get a new Client instance.
public newClient ( ) : Client
return Client

newTransportProvider() public method

Get a new transport provider instance.
public newTransportProvider ( ) : Thruway\Transport\PawlTransportProvider
return Thruway\Transport\PawlTransportProvider

register() public method

Register the given provider.
public register ( Closur\Closure | string $provider )
$provider Closur\Closure | string

run() public method

Run the server.
public run ( array $options = [] )
$options array

transportUrl() public method

Get the transport URL that provider should connect to.
public transportUrl ( ) : string
return string