Application controller class for organization of business logic. Provides basic functionality, such as rendering views inside layouts, automatic model availability, redirection, callbacks, and more.
Controllers should provide a number of 'action' methods. These are public methods on a controller that are not inherited from Controller. Each action serves as an endpoint for performing a specific action on a resource or collection of resources. For example adding or editing a new object, or listing a set of objects.
You can access request parameters, using $this->request. The request object contains all the POST, GET and FILES that were part of the request.
After performing the required action, controllers are responsible for creating a response. This usually takes the form of a generated View, or possibly a redirection to another URL. In either case $this->response allows you to manipulate all aspects of the response.
Controllers are created by Dispatcher based on request parameters and routing. By default controllers and actions use conventional names. For example /posts/index maps to PostsController::index(). You can re-map URLs using Router::connect() or RouterBuilder::connect().
CakePHP fires a number of life cycle callbacks during each request. By implementing a method you can receive the related events. The available callbacks are:
beforeFilter(Event $event) Called before each action. This is a good place to do general logic that applies to all actions.beforeRender(Event $event) Called before the view is rendered.beforeRedirect(Event $event, $url, Response $response) Called before a redirect is done.afterFilter(Event $event) Called after each action is complete and after the view is rendered.$View public Instance of the View created during rendering. Won't be set until after Controller::render() is called.
$_components protected $_responseClass protected string$_validViewOptions protected array$autoRender public booleanSet to true to automatically render the view after action logic.
$components public arrayArray containing the names of components this controller uses. Component names should not contain the "Component" portion of the class name.
$helpers public arrayAn array containing the names of helpers this controller uses. The array elements should not contain the "Helper" part of the class name.
$name public string$paginate public array$passedArgs public array$plugin public string$request public An instance of a Cake\Network\Request object that contains information about the current request. This object contains all the information about a request and several methods for reading additional information about the request.
$response public Cake\Network\Response$Auth public $Cookie public $Csrf public $Flash public $Paginator public $RequestHandler public $Security public _eventClass, _eventManager _tableLocator _modelFactories, _modelType, modelClass _viewBuilder, viewClass, viewVars Merge components, helpers vars from parent classes.
Called before the controller action. You can use this method to configure and customize components or perform logic that needs to happen before each controller action.
The beforeRedirect method is invoked when the controller's redirect method is called but before any further action.
Called after the controller action is run, but before the view is rendered. You can use this method to perform logic or set view variables that are required on every request.
Returns a list of all events that will fire in the controller during its lifecycle. You can override this function to add your own listener callbacks
Dispatches the controller action. Checks that the action exists and isn't private.
Sets the request objects and configures a number of controller properties based on the contents of the request. Controller acts as a proxy for certain View variables which must also be updated here. The properties that get set are:
Perform the various shutdown processes for this controller. Fire the Components and Controller callbacks in the correct order.
Perform the startup process for this controller. Fire the Components and Controller callbacks in the correct order.
__construct( Cake\Http\ServerRequest $request null , Cake\Network\Response $response null , string|null $name null , Cake\Event\EventManager|null $eventManager null , Cake\Controller\ComponentRegistry|null $components null )
Constructor.
Sets a number of properties based on conventions if they are empty. To override the conventions CakePHP uses you can define properties in your class declaration.
Cake\Http\ServerRequest $request optional null Request object for this controller. Can be null for testing, but expect that features that use the request parameters will not work.
$response optional null $name optional null Cake\Event\EventManager|null $eventManager optional null Cake\Controller\ComponentRegistry|null $components optional null __get( string $name )
Magic accessor for model autoloading.
$name __set( string $name , mixed $value )
Magic setter for removed properties.
$name $value _loadComponents( )
Loads the defined components using the Component factory.
_mergeControllerVars( )
Merge components, helpers vars from parent classes.
_viewPath( )
Get the viewPath based on controller name and request prefix.
afterFilter( Cake\Event\Event $event )
Called after the controller action is run and rendered.
Cake\Event\Event $event beforeFilter( Cake\Event\Event $event )
Called before the controller action. You can use this method to configure and customize components or perform logic that needs to happen before each controller action.
Cake\Event\Event $event beforeRedirect( Cake\Event\Event $event , string|array $url , Cake\Network\Response $response )
The beforeRedirect method is invoked when the controller's redirect method is called but before any further action.
If the event is stopped the controller will not continue on to redirect the request. The $url and $status variables have same meaning as for the controller's method. You can set the event result to response instance or modify the redirect location using controller's response instance.
Cake\Event\Event $event $url A string or array-based URL pointing to another location within the app, or an absolute URL
$response beforeRender( Cake\Event\Event $event )
Called after the controller action is run, but before the view is rendered. You can use this method to perform logic or set view variables that are required on every request.
Cake\Event\Event $event components( Cake\Controller\ComponentRegistry|null $components null )
Get the component registry for this controller.
If called with the first parameter, it will be set as the controller $this->_components property
Cake\Controller\ComponentRegistry|null $components optional null Cake\Controller\ComponentRegistryimplementedEvents( )
Returns a list of all events that will fire in the controller during its lifecycle. You can override this function to add your own listener callbacks
Cake\Event\EventListenerInterface::implementedEvents() initialize( )
Initialization hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
invokeAction( )
Dispatches the controller action. Checks that the action exists and isn't private.
Cake\Controller\Exception\MissingActionExceptionisAction( string $action )
Method to check that an action is accessible from a URL.
Override this method to change which controller methods can be reached. The default implementation disallows access to all methods defined on Cake\Controller\Controller, and allows all public methods on all subclasses of this class.
$action loadComponent( string $name , array $config [] )
Add a component to the controller's registry.
This method will also set the component to a property. For example:
$this->loadComponent('Acl.Acl'); Will result in a Toolbar property being set.
$name $config optional [] Cake\Controller\Componentpaginate( Cake\ORM\Table|string|Cake\ORM\Query|null $object null , array $settings [] )
Handles pagination of records in Table objects.
Will load the referenced Table object, and have the PaginatorComponent paginate the query using the request date and settings defined in $this->paginate.
This method will also make the PaginatorHelper available in the view.
Cake\ORM\Table|string|Cake\ORM\Query|null $object optional null Table to paginate (e.g: Table instance, 'TableName' or a Query object)
$settings optional [] Cake\ORM\ResultSetredirect( string|array $url , integer $status 302 )
Redirects to given $url, after turning off $this->autoRender.
$url A string or array-based URL pointing to another location within the app, or an absolute URL
$status optional 302 referer( string|array|null $default null , boolean $local false )
Returns the referring URL for this request.
$default optional null $local optional false render( string|null $view null , string|null $layout null )
Instantiates the correct view class, hands it its data, and uses it to render the view output.
$view optional null $layout optional null setAction( string $action , ... $args )
Internally redirects one action to another. Does not perform another HTTP request unlike Controller::redirect()
Examples:
setAction('another_action');
setAction('action_with_parameters', $parameter1); $action The new action to be 'redirected' to. Any other parameters passed to this method will be passed as parameters to the new action.
$args setRequest( Cake\Http\ServerRequest $request )
Sets the request objects and configures a number of controller properties based on the contents of the request. Controller acts as a proxy for certain View variables which must also be updated here. The properties that get set are:
Cake\Http\ServerRequest $request shutdownProcess( )
Perform the various shutdown processes for this controller. Fire the Components and Controller callbacks in the correct order.
shutdown callback.afterFilter method.startupProcess( )
Perform the startup process for this controller. Fire the Components and Controller callbacks in the correct order.
initialize callbackbeforeFilter.startup methods.dispatchEvent( string $name , array|null $data null , object|null $subject null )
Wrapper for creating and dispatching events.
Returns a dispatched event.
$name $data optional null Any value you wish to be transported with this event to it can be read by listeners.
$subject optional null The object that this event applies to ($this by default).
Cake\Event\EventeventManager( 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.
Cake\Event\EventManager $eventManager optional null Cake\Event\EventManagertableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator null )
Sets the table locator. If no parameters are passed, it will return the currently used locator.
Cake\ORM\Locator\LocatorInterface $tableLocator optional null Cake\ORM\Locator\LocatorInterfacelog( mixed $msg , integer|string $level LogLevel::ERROR , string|array $context [] )
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
$msg $level optional LogLevel::ERROR $context optional [] _mergeProperty( string $property , array $parentClasses , array $options )
Merge a single property with the values declared in all parent classes.
$property $parentClasses $options _mergePropertyData( array $current , array $parent , boolean $isAssoc )
Merge each of the keys in a property together.
$current $parent $isAssoc _mergeVars( array $properties , array $options [] )
Merge the list of $properties with all parent classes of the current class.
associative - A list of properties that should be treated as associative arrays. Properties in this list will be passed through Hash::normalize() before merging.$properties $options optional [] _setModelClass( string $name )
Set the modelClass and modelKey properties based on conventions.
If the properties are already set they will not be overwritten
$name loadModel( string|null $modelClass null , string|null $modelType null )
Loads and constructs repository objects required by this object
Typically used to load ORM Table objects as required. Can also be used to load other types of repository objects your application uses.
If a repository provider does not return an object a MissingModelException will be thrown.
$modelClass optional null $modelType optional null Cake\Datasource\RepositoryInterfaceCake\Datasource\Exception\MissingModelExceptionmodelFactory( string $type , callable $factory )
Override a existing callable to generate repositories of a given type.
$type $factory modelType( string|null $modelType null )
Set or get the model type to be used by this class
$modelType optional null Cake\Datasource\ModelAwareTraitrequestAction( string|array $url , array $extra [] )
Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
Under the hood this method uses Router::reverse() to convert the $url parameter into a string URL. You should use URL formats that are compatible with Router::reverse()
A basic example getting the return value of the controller action:
$variables = $this->requestAction('/articles/popular'); A basic example of request action to fetch a rendered page without the layout.
$viewHtml = $this->requestAction('/articles/popular', ['return']); You can also pass the URL as an array:
$vars = $this->requestAction(['controller' => 'articles', 'action' => 'popular']);
You can pass POST, GET, COOKIE and other data into the request using the appropriate keys. Cookies can be passed using the cookies key. Get parameters can be set with query and post data can be sent using the post key.
$vars = $this->requestAction('/articles/popular', [
'query' => ['page' => 1],
'cookies' => ['remember_me' => 1],
]); By default actions dispatched with this method will use the global $_SERVER and $_ENV values. If you want to override those values for a request action, you can specify the values:
$vars = $this->requestAction('/articles/popular', [
'environment' => ['CONTENT_TYPE' => 'application/json']
]); By default actions dispatched with this method will use the standard session object. If you want a particular session instance to be used, you need to specify it.
$vars = $this->requestAction('/articles/popular', [
'session' => new Session($someSessionConfig)
]); $url String or array-based url. Unlike other url arrays in CakePHP, this url will not automatically handle passed arguments in the $url parameter.
$extra optional [] if array includes the key "return" it sets the autoRender to true. Can also be used to submit GET/POST data, and passed arguments.
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
createView( string|null $viewClass null )
Constructs the view class instance based on the current configuration.
$viewClass optional null Cake\View\ViewCake\View\Exception\MissingViewExceptionset( string|array $name , mixed $value null )
Saves a variable or an associative array of variables for use inside a template.
$name $value optional null Value in case $name is a string (which then works as the key). Unused if $name is an associative array, otherwise serves as the values to $name's keys.
viewBuilder( )
Get the view builder being used.
Cake\View\ViewBuilderviewOptions( string|array|null $options null , boolean $merge true )
Get/Set valid view options in the object's _validViewOptions property. The property is created as an empty array if it is not set. If called without any parameters it will return the current list of valid view options. See createView().
$options optional null $merge optional true Whether to merge with or override existing valid View options. Defaults to true.
public Cake\View\View
Instance of the View created during rendering. Won't be set until after Controller::render() is called.
protected Cake\Controller\ComponentRegistry
Instance of ComponentRegistry used to create Components
null
protected string
The class name to use for creating the response object.
'Cake\Network\Response'
protected array
These Controller properties will be passed from the Controller to the View as options.
Cake\View\View[
'passedArgs'
] public boolean
Set to true to automatically render the view after action logic.
true
public array
Array containing the names of components this controller uses. Component names should not contain the "Component" portion of the class name.
Example:
public $components = ['RequestHandler', 'Acl'];
[]
public array
An array containing the names of helpers this controller uses. The array elements should not contain the "Helper" part of the class name.
Example:
public $helpers = ['Form', 'Html', 'Time'];
[]
public string
The name of this controller. Controller names are plural, named after the model they manipulate.
Set automatically using conventions in Controller::__construct().
null
public array
Settings for pagination.
Used to pre-configure pagination preferences for the various tables your controller will be paginating.
Cake\Controller\Component\PaginatorComponent[]
public array
Holds all passed params.
$this->request->getParam('pass') instead.[]
public Cake\Http\ServerRequest
An instance of a Cake\Network\Request object that contains information about the current request. This object contains all the information about a request and several methods for reading additional information about the request.
public Cake\Network\Response
An instance of a Response object that contains information about the impending response
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.4/class-Cake.Controller.Controller.html