\Pivot\Core\AppPivot

The Pivot App

Summary

Methods
Properties
Constants
__construct()
run()
getServiceLocator()
getRelay()
setRelay()
getRequest()
setRequest()
getResponse()
setResponse()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$serviceLocator
$relay
$request
$response
N/A

Properties

$serviceLocator

$serviceLocator : \Pivot\Core\App\Pivot\Core\Service\ServiceLocator

The service locator for the app. Also has configuration.

Type

\Pivot\Core\App\Pivot\Core\Service\ServiceLocator

$relay

$relay : \Relay\Relay\RelayBuilder

Relay is a PSR-7 middleware dispatcher

Type

\Relay\Relay\RelayBuilder

$request

$request : Mixed

PSR-7 Compliant request object

Type

Mixed

$response

$response : Mixed

PSR-7 Compliant response object

Type

Mixed

Methods

__construct()

__construct(object  $pivotConfig, string  $appMode = null, array  $injectablePayload = array()) 

Boots up Pivot based on configuration and application mode

Parameters

object $pivotConfig

Pivot\Core\Configuration\PivotConfig

string $appMode

overrides the APPLICATION_MODE

array $injectablePayload

Adds data to the request, like a queue payload

run()

run() : mixed

Executes the middleware relay

Returns

mixed —

response from the relay

getServiceLocator()

getServiceLocator() : Object

Returns the serviceLocator

Returns

Object —

Pivot\Core\Services\ServiceLocator

getRelay()

getRelay() : \Relay\Relay\RelayBuilder

Get the value of Relay is a PSR-7 middleware dispatcher

Returns

\Relay\Relay\RelayBuilder

setRelay()

setRelay(\Relay\Relay  $relay) : self

Set the value of Relay is a PSR-7 middleware dispatcher

Parameters

\Relay\Relay $relay

Returns

self

getRequest()

getRequest() : Mixed

Get the value of PSR-7 Compliant request object

Returns

Mixed

setRequest()

setRequest(  $request) : self

Set the value of PSR-7 Compliant request object

Parameters

$request

Returns

self

getResponse()

getResponse() : Mixed

Get the value of PSR-7 Compliant response object

Returns

Mixed

setResponse()

setResponse(  $response) : self

Set the value of PSR-7 Compliant response object

Parameters

$response

Returns

self