Class Server
Runs an application invoking all the PSR7 middleware and the registered application.
- Cake\Http\Server implements Cake\Event\EventDispatcherInterface uses Cake\Event\EventDispatcherTrait
Properties summary
Inherited Properties
Method Summary
-
__construct() public
Constructor -
bootstrap() protected
Application bootstrap wrapper. -
emit() public
Emit the response using the PHP SAPI. -
eventManager() public deprecated
Get/set the application's event manager. -
getApp() public
Get the current application. -
getEventManager() public
Get the application's event manager or the global one. -
run() public
Run the request/response through the Application and its middleware. -
setEventManager() public
Get/set the application's event manager. -
setRunner() public
Set the runner
Method Detail
bootstrap() protected ¶
bootstrap( )
Application bootstrap wrapper.
Calls bootstrap() and events() if application implements EventApplicationInterface.
After the application is bootstrapped and events are attached, plugins are bootstrapped
and have their events attached.
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.
eventManager() public deprecated ¶
eventManager( Cake\Event\EventManager $events = null )
Get/set the application's event manager.
If the application does not support events and this method is used as a setter, an exception will be raised.
Deprecated
Parameters
-
Cake\Event\EventManager$events optional null - The event manager to set.
Returns
Implementation of
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.
setEventManager() public ¶
setEventManager( Cake\Event\EventManager $events )
Get/set the application's event manager.
If the application does not support events and this method is used as a setter, an exception will be raised.
Parameters
-
Cake\Event\EventManager$events - The event manager 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
Magic methods inherited from Cake\Event\EventDispatcherInterface
getEventManager()
|