Class Server
Runs an application invoking all the PSR7 middleware and the registered application.
Property Summary
-
$_eventClass protected
stringDefault class name for new event objects.
-
$_eventManager protected
Cake\Event\EventManagerInterface|nullInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
-
$app protected
Cake\Core\HttpApplicationInterface -
$runner protected
Cake\Http\Runner
Method Summary
-
__construct() public
Constructor
-
bootstrap() protected
Application bootstrap wrapper.
-
dispatchEvent() public
Wrapper for creating and dispatching events.
-
emit() public
Emit the response using the PHP SAPI.
-
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
Set the application's event manager.
Method Detail
__construct() ¶ public
__construct(Cake\Core\HttpApplicationInterface $app, Cake\Http\Runner|null $runner = null)Constructor
Parameters
-
Cake\Core\HttpApplicationInterface$app The application to use.
-
Cake\Http\Runner|null$runner optional Application runner.
bootstrap() ¶ protected
bootstrap(): voidApplication bootstrap wrapper.
Calls the application's bootstrap() hook. After the application the
plugins are bootstrapped.
Returns
voiddispatchEvent() ¶ public
dispatchEvent(string $name, array $data = [], TSubject|null $subject = null): Cake\Event\EventInterface<TSubject>Wrapper for creating and dispatching events.
Returns a dispatched event.
Parameters
-
string$name Name of the event.
-
array$data optional Any value you wish to be transported with this event to it can be read by listeners.
-
TSubject|null$subject optional The object that this event applies to ($this by default).
Returns
Cake\Event\EventInterface<TSubject>emit() ¶ public
emit(Psr\Http\Message\ResponseInterface $response, Cake\Http\ResponseEmitter|null $emitter = null): voidEmit the response using the PHP SAPI.
After the response has been emitted, the Server.terminate event will be triggered.
The Server.terminate event can be used to do potentially heavy tasks after the
response is sent to the client. Only the PHP FPM server API is able to send a
response to the client while the server's PHP process still performs some tasks.
For other environments the event will be triggered before the response is flushed
to the client and will have no benefit.
Parameters
-
Psr\Http\Message\ResponseInterface$response The response to emit
-
Cake\Http\ResponseEmitter|null$emitter optional The emitter to use. When null, a SAPI Stream Emitter will be used.
Returns
voidgetApp() ¶ public
getApp(): Cake\Core\HttpApplicationInterfaceGet the current application.
Returns
Cake\Core\HttpApplicationInterfacegetEventManager() ¶ public
getEventManager(): Cake\Event\EventManagerInterfaceGet the application's event manager or the global one.
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
Cake\Event\EventManagerInterfacerun() ¶ public
run(Psr\Http\Message\ServerRequestInterface|null $request = null, Cake\Http\MiddlewareQueue|null $middlewareQueue = null): Psr\Http\Message\ResponseInterfaceRun 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|null$request optional The request to use or null.
-
Cake\Http\MiddlewareQueue|null$middlewareQueue optional MiddlewareQueue or null.
Returns
Psr\Http\Message\ResponseInterfaceThrows
RuntimeExceptionWhen the application does not make a response.
setEventManager() ¶ public
setEventManager(Cake\Event\EventManagerInterface $eventManager): $thisSet the application's event manager.
If the application does not support events, an exception will be raised.
Parameters
-
Cake\Event\EventManagerInterface$eventManager The event manager to set.
Returns
$thisThrows
InvalidArgumentExceptionProperty Detail
$_eventManager ¶ protected
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
Type
Cake\Event\EventManagerInterface|null