CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (GitHub)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • Slack
    • Paid Support
CakePHP

C CakePHP 2.5 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 2.5
      • 4.2
      • 4.1
      • 4.0
      • 3.9
      • 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

Packages

  • Cake
    • Cache
      • Engine
    • Configure
    • Console
      • Command
        • Task
    • Controller
      • Component
        • Acl
        • Auth
    • Core
    • Error
    • Event
    • I18n
    • Log
      • Engine
    • Model
      • Behavior
      • Datasource
        • Database
        • Session
      • Validator
    • Network
      • Email
      • Http
    • Routing
      • Filter
      • Route
    • TestSuite
      • Coverage
      • Fixture
      • Reporter
    • Utility
    • View
      • Helper

Classes

  • CakeTestCase
  • CakeTestLoader
  • CakeTestRunner
  • CakeTestSuite
  • CakeTestSuiteCommand
  • CakeTestSuiteDispatcher
  • ControllerTestCase
  • ControllerTestDispatcher
  • InterceptContentHelper

Class ControllerTestDispatcher

ControllerTestDispatcher class

Dispatcher implements CakeEventListener
Extended by ControllerTestDispatcher
Package: Cake\TestSuite
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/TestSuite/ControllerTestCase.php

Properties summary

  • $loadRoutes public
    boolean
    Use custom routes during tests
  • $testController public
    Controller
    The controller to use in the dispatch process

Inherited Properties

  • _eventManager

Method Summary

  • _getController() protected
    Returns the test controller
  • _loadRoutes() protected
    Loads routes and resets if the test case dictates it should

Method Detail

_getController() protected ¶

_getController( CakeRequest $request , CakeResponse $response )

Returns the test controller

Parameters
CakeRequest $request
The request instance.
CakeResponse $response
The response instance.
Returns
Controller
Overrides
Dispatcher::_getController()

_loadRoutes() protected ¶

_loadRoutes( )

Loads routes and resets if the test case dictates it should

Methods inherited from Dispatcher

__construct() public ¶

__construct( string $base = false )

Constructor.

Parameters
string $base optional false
The base directory for the application. Writes App.base to Configure.

_attachFilters() protected ¶

_attachFilters( CakeEventManager $manager )

Attaches all event listeners for this dispatcher instance. Loads the dispatcher filters from the configured locations.

Parameters
CakeEventManager $manager
Event manager instance.
Throws
MissingDispatcherFilterException

_invoke() protected ¶

_invoke( Controller $controller , CakeRequest $request )

Initializes the components and models a controller will be using. Triggers the controller action, and invokes the rendering if Controller::$autoRender is true and echo's the output. Otherwise the return value of the controller action are returned.

Parameters
Controller $controller
Controller to invoke
CakeRequest $request
The request object to invoke the controller for.
Returns
CakeResponse
the resulting response object

_loadController() protected ¶

_loadController( CakeRequest $request )

Load controller and return controller class name

Parameters
CakeRequest $request
Request instance.
Returns
string|boolean
Name of controller class name

dispatch() public ¶

dispatch( CakeRequest $request , CakeResponse $response , array $additionalParams = array() )

Dispatches and invokes given Request, handing over control to the involved controller. If the controller is set to autoRender, via Controller::$autoRender, then Dispatcher will render the view.

Actions in CakePHP can be any public method on a controller, that is not declared in Controller. If you want controller methods to be public and in-accessible by URL, then prefix them with a _. For example public function _loadPosts() { } would not be accessible via URL. Private and protected methods are also not accessible via URL.

If no controller of given name can be found, invoke() will throw an exception. If the controller is found, and the action is not found an exception will be thrown.

Parameters
CakeRequest $request
Request object to dispatch.
CakeResponse $response
Response object to put the results of the dispatch into.
array $additionalParams optional array()
Settings array ("bare", "return") which is melded with the GET and POST params
Returns
string|
if $request['return'] is set then it returns response body, null otherwise
Throws
MissingControllerException
When the controller is missing.
Triggers
Dispatcher.beforeDispatch $this, compact('request', 'response', 'additionalParams')
Dispatcher.afterDispatch $this, compact('request', 'response')

getEventManager() public ¶

getEventManager( )

Returns the CakeEventManager instance or creates one if none was created. Attaches the default listeners and filters

Returns
CakeEventManager

implementedEvents() public ¶

implementedEvents( )

Returns the list of events this object listens to.

Returns
array
Implementation of
CakeEventListener::implementedEvents()

parseParams() public ¶

parseParams( CakeEvent $event )

Applies Routing and additionalParameters to the request to be dispatched. If Routes have not been loaded they will be loaded, and app/Config/routes.php will be run.

Parameters
CakeEvent $event
containing the request, response and additional params

Properties detail

$loadRoutes ¶

public boolean

Use custom routes during tests

true

$testController ¶

public Controller

The controller to use in the dispatch process

null
OpenHub
Rackspace
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (GitHub)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • Slack
  • Paid Support

Generated using CakePHP API Docs