Class Server
Runs an application invoking all the PSR7 middleware and the registered application.
- Cake\Http\Server uses Cake\Event\EventDispatcherTrait
Properties summary
Inherited Properties
Method Summary
-
__construct() public
Constructor -
emit() public
Emit the response using the PHP SAPI. -
getApp() public
Get the current application. -
run() public
Run the request/response through the Application and its middleware. -
setApp() public
Set the application. -
setRunner() public
Set the runner
Method Detail
emit() public ¶
emit( Psr\Http\Message\ResponseInterface $response , Zend\Diactoros\Response\EmitterInterface $emitter = null )
Emit the response using the PHP SAPI.
Parameters
- Psr\Http\Message\ResponseInterface $response
- The response to emit
- Zend\Diactoros\Response\EmitterInterface $emitter optional null
The emitter to use. When null, a SAPI Stream Emitter will be used.
run() public ¶
run( Psr\Http\Message\ServerRequestInterface $request = null , Psr\Http\Message\ResponseInterface $response = null )
Run the request/response through the Application and its middleware.
This will invoke the following methods:
- App->bootstrap() - Perform any bootstrapping logic for your application here.
- App->middleware() - Attach any application middleware here.
- Trigger the 'Server.buildMiddleware' event. You can use this to modify the from event listeners.
- Run the middleware queue including the application.
Parameters
- Psr\Http\Message\ServerRequestInterface $request optional null
- The request to use or null.
- Psr\Http\Message\ResponseInterface $response optional null
- The response to use or null.
Returns
Throws
When the application does not make a response.
setApp() public ¶
setApp( Cake\Core\HttpApplicationInterface $app )
Set the application.
Parameters
-
Cake\Core\HttpApplicationInterface$app - The application to set.
Returns
$this
Methods used from Cake\Event\EventDispatcherTrait
dispatchEvent() public ¶
dispatchEvent( string $name , array|null $data = null , object|null $subject = null )
Wrapper for creating and dispatching events.
Returns a dispatched event.
Parameters
- string $name
- Name of the event.
- array|null $data optional null
Any value you wish to be transported with this event to it can be read by listeners.
- object|null $subject optional null
The object that this event applies to ($this by default).
Returns
eventManager() public deprecated ¶
eventManager( Cake\Event\EventManager $eventManager = null )
Returns the Cake\Event\EventManager manager instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Deprecated
Parameters
-
Cake\Event\EventManager$eventManager optional null - the eventManager to set
Returns
getEventManager() public ¶
getEventManager( )
Returns the Cake\Event\EventManager manager instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Returns
setEventManager() public ¶
setEventManager( Cake\Event\EventManager $eventManager )
Returns the Cake\Event\EventManager manager instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Parameters
-
Cake\Event\EventManager$eventManager - the eventManager to set
Returns
$this