• Home
• Cake
• Controller
• Controller

PHP Class Cake\Controller\Controller

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(). ### Life cycle callbacks 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. Show file Open project: cakephp/cakephp Class Usage Examples

Public Properties

Property	Type	Description
$View	Cake\View\View	Instance of the View created during rendering. Won't be set until after Controller::render() is called.
$autoRender	boolean	Set to true to automatically render the view after action logic.
$components	array	Example: public $components = ['RequestHandler', 'Acl'];
$helpers	array	Example: public $helpers = ['Form', 'Html', 'Time'];
$name	string	Set automatically using conventions in Controller::__construct().
$paginate	array	Used to pre-configure pagination preferences for the various tables your controller will be paginating.
$passedArgs	array	Holds all passed params.
$plugin	string	Automatically set to the name of a plugin.
$request	Cake\Network\Request	This object contains all the information about a request and several methods for reading additional information about the request.
$response	Cake\Network\Response	An instance of a Response object that contains information about the impending response

Protected Properties

Property	Type	Description
$_components	Cake\Controller\ComponentRegistry	Instance of ComponentRegistry used to create Components
$_responseClass	string	The class name to use for creating the response object.
$_validViewOptions	array	These Controller properties will be passed from the Controller to the View as options.

Public Methods

Method	Description
__construct ( Cake\Network\Request $request = null, Response $response = null, string | null $name = null, Cake\Event\EventManager | null $eventManager = null, Cake\Controller\ComponentRegistry | null $components = null )	Constructor.
__get ( string $name ) : boolean | object	Magic accessor for model autoloading.
__set ( string $name, mixed $value ) : void	Magic setter for removed properties.
afterFilter ( Cake\Event\Event $event ) : Response | null	Called after the controller action is run and rendered.
beforeFilter ( Cake\Event\Event $event ) : Response | null	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.
beforeRedirect ( Cake\Event\Event $event, string | array $url, Response $response ) : Response | null	The beforeRedirect method is invoked when the controller's redirect method is called but before any further action.
beforeRender ( Cake\Event\Event $event ) : Response | null	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.
components ( Cake\Controller\ComponentRegistry | null $components = null ) : Cake\Controller\ComponentRegistry	Get the component registry for this controller.
implementedEvents ( ) : array	Returns a list of all events that will fire in the controller during its lifecycle.
initialize ( ) : void	Initialization hook method.
invokeAction ( ) : mixed	Dispatches the controller action. Checks that the action exists and isn't private.
isAction ( string $action ) : boolean	Method to check that an action is accessible from a URL.
loadComponent ( string $name, array $config = [] ) : Component	Add a component to the controller's registry.
paginate ( Table | string | Query | null $object = null, array $settings = [] ) : Cake\ORM\ResultSet	Handles pagination of records in Table objects.
redirect ( string | array $url, integer $status = 302 ) : Response | null	Redirects to given $url, after turning off $this->autoRender.
referer ( string | array | null $default = null, boolean $local = false ) : string	Returns the referring URL for this request.
render ( string | null $view = null, string | null $layout = null ) : Response	Instantiates the correct view class, hands it its data, and uses it to render the view output.
setAction ( string $action ) : mixed	Internally redirects one action to another. Does not perform another HTTP request unlike Controller::redirect()
setRequest ( Cake\Network\Request $request ) : void	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:
shutdownProcess ( ) : Response | null	Perform the various shutdown processes for this controller.
startupProcess ( ) : Response | null	Perform the startup process for this controller.

Protected Methods

Method	Description
_loadComponents ( ) : void	Loads the defined components using the Component factory.
_mergeControllerVars ( ) : void	Merge components, helpers vars from parent classes.
_viewPath ( ) : string	Get the viewPath based on controller name and request prefix.

Method Details

Property Details