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\EventManagerInstance 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
-
dispatchEvent() public
Wrapper for creating and dispatching events.
-
emit() public
Emit the response using the PHP SAPI.
-
eventManager() public deprecated
Returns the Cake\Event\EventManager manager instance for this object.
-
getApp() public
Get the current application.
-
getEventManager() public
Returns the Cake\Event\EventManager manager instance for this object.
-
run() public
Run the request/response through the Application and its middleware.
-
setApp() public
Set the application.
-
setEventManager() public
Returns the Cake\Event\EventManager manager instance for this object.
-
setRunner() public
Set the runner
Method Detail
__construct() ¶ public
__construct(Cake\Core\HttpApplicationInterface $app)Constructor
Parameters
-
Cake\Core\HttpApplicationInterface$app The application to use.
dispatchEvent() ¶ public
dispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventWrapper for creating and dispatching events.
Returns a dispatched event.
Parameters
-
string$name Name of the event.
-
array|null$data optional Any value you wish to be transported with this event to it can be read by listeners.
-
object|null$subject optional The object that this event applies to ($this by default).
Returns
Cake\Event\Eventemit() ¶ public
emit(Psr\Http\Message\ResponseInterface $response, Zend\Diactoros\Response\EmitterInterface|null $emitter = null): voidEmit the response using the PHP SAPI.
Parameters
-
Psr\Http\Message\ResponseInterface$response The response to emit
-
Zend\Diactoros\Response\EmitterInterface|null$emitter optional The emitter to use. When null, a SAPI Stream Emitter will be used.
Returns
voideventManager() ¶ public
eventManager(Cake\Event\EventManager|null $eventManager = null): Cake\Event\EventManagerReturns 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|null$eventManager optional the eventManager to set
Returns
Cake\Event\EventManagergetApp() ¶ public
getApp(): Cake\Core\HttpApplicationInterfaceGet the current application.
Returns
Cake\Core\HttpApplicationInterfacegetEventManager() ¶ public
getEventManager(): Cake\Event\EventManagerReturns 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
Cake\Event\EventManagerrun() ¶ public
run(Psr\Http\Message\ServerRequestInterface|null $request = null, Psr\Http\Message\ResponseInterface|null $response = 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.
-
Psr\Http\Message\ResponseInterface|null$response optional The response to use or null.
Returns
Psr\Http\Message\ResponseInterfaceThrows
RuntimeExceptionWhen the application does not make a response.
setApp() ¶ public
setApp(Cake\Core\HttpApplicationInterface $app): $thisSet the application.
Parameters
-
Cake\Core\HttpApplicationInterface$app The application to set.
Returns
$thissetEventManager() ¶ public
setEventManager(Cake\Event\EventManager $eventManager): $thisReturns 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
$thissetRunner() ¶ public
setRunner(Cake\Http\Runner $runner): $thisSet the runner
Parameters
-
Cake\Http\Runner$runner The runner to use.
Returns
$thisProperty Detail
$_eventManager ¶ protected
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
Type
Cake\Event\EventManager