CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Team
    • Issues (Github)
    • YouTube Channel
    • Get Involved
    • Bakery
    • Featured Resources
    • Newsletter
    • Certification
    • My CakePHP
    • CakeFest
    • Facebook
    • Twitter
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.5 Red Velvet API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 3.5
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Cake
    • Auth
      • Storage
    • Cache
      • Engine
    • Collection
      • Iterator
    • Console
      • Exception
    • Controller
      • Component
      • Exception
    • Core
      • Configure
        • Engine
      • Exception
    • Database
      • Driver
      • Exception
      • Expression
      • Schema
      • Statement
      • Type
    • Datasource
      • Exception
    • Error
      • Middleware
    • Event
      • Decorator
    • Filesystem
    • Form
    • Http
      • Client
        • Adapter
        • Auth
      • Cookie
      • Middleware
    • I18n
      • Formatter
      • Middleware
      • Parser
    • Log
      • Engine
    • Mailer
      • Exception
      • Transport
    • Network
      • Exception
      • Session
    • ORM
      • Association
      • Behavior
        • Translate
      • Exception
      • Locator
      • Rule
    • Routing
      • Exception
      • Filter
      • Middleware
      • Route
    • Shell
      • Helper
      • Task
    • TestSuite
      • Constraint
      • Fixture
      • Stub
    • Utility
      • Exception
    • Validation
    • View
      • Exception
      • Form
      • Helper
      • Widget
  • None

Classes

  • ActionDispatcher
  • BaseApplication
  • Client
  • ControllerFactory
  • MiddlewareQueue
  • Response
  • ResponseEmitter
  • Runner
  • Server
  • ServerRequest
  • ServerRequestFactory

Class Server

Runs an application invoking all the PSR7 middleware and the registered application.

Cake\Http\Server uses Cake\Event\EventDispatcherTrait
Namespace: Cake\Http
Location: Http/Server.php

Properties summary

  • $app protected
    Cake\Core\HttpApplicationInterface
  • $runner protected
    Cake\Http\Runner

Inherited Properties

  • _eventClass, _eventManager

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

__construct() public ¶

__construct( Cake\Core\HttpApplicationInterface $app )

Constructor

Parameters
Cake\Core\HttpApplicationInterface $app
The application to use.

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.

getApp() public ¶

getApp( )

Get the current application.

Returns
Cake\Core\HttpApplicationInterface
The application that will be run.

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
Psr\Http\Message\ResponseInterface
Throws
RuntimeException
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

setRunner() public ¶

setRunner( Cake\Http\Runner $runner )

Set the runner

Parameters
Cake\Http\Runner $runner
The runner to use.
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
Cake\Event\Event

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
3.5.0 Use getEventManager()/setEventManager() instead.
Parameters
Cake\Event\EventManager $eventManager optional null
the eventManager to set
Returns
Cake\Event\EventManager

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
Cake\Event\EventManager

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

Properties detail

$app ¶

protected Cake\Core\HttpApplicationInterface

$runner ¶

protected Cake\Http\Runner
Follow @CakePHP
#IRC
OpenHub
Rackspace
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Logos & Trademarks
  • Community
  • Team
  • Issues (Github)
  • YouTube Channel
  • Get Involved
  • Bakery
  • Featured Resources
  • Newsletter
  • Certification
  • My CakePHP
  • CakeFest
  • Facebook
  • Twitter
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs