Class Controller

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().

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.

Namespace: Cake\Controller
Link: https://book.cakephp.org/3/en/controllers.html

Property Summary

$Auth public @property

Cake\Controller\Component\AuthComponent
$Cookie public @property

Cake\Controller\Component\CookieComponent
$Csrf public @property

Cake\Controller\Component\CsrfComponent
$Flash public @property

Cake\Controller\Component\FlashComponent
$Paginator public @property

Cake\Controller\Component\PaginatorComponent
$RequestHandler public @property

Cake\Controller\Component\RequestHandlerComponent
$Security public @property

Cake\Controller\Component\SecurityComponent
$View public deprecated

Cake\View\View

Instance of the View created during rendering. Won't be set until after Controller::render() is called.
$_components protected

Cake\Controller\ComponentRegistry

Instance of ComponentRegistry used to create Components
$_eventClass protected

string

Default class name for new event objects.
$_eventManager protected

Cake\Event\EventManagerInterfaceCake\Event\EventManager

Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
$_modelFactories protected

array

A list of overridden model factory functions.
$_modelType protected

string

The model type to use.
$_responseClass protected

string

The class name to use for creating the response object.
$_tableLocator protected

Cake\ORM\Locator\LocatorInterface

Table locator instance
$_validViewOptions protected deprecated

array

These Controller properties will be passed from the Controller to the View as options.
$_viewBuilder protected

Cake\View\ViewBuilder

The view builder instance being used.
$autoRender protected

bool

Set to true to automatically render the view after action logic.
$components public deprecated

array

Array containing the names of components this controller uses. Component names should not contain the "Component" portion of the class name.
$helpers public deprecated

array

An array containing the names of helpers this controller uses. The array elements should not contain the "Helper" part of the class name.
$modelClass public

string|false|null

This object's primary model class name. Should be a plural form. CakePHP will not inflect the name.
$name protected

string

The name of this controller. Controller names are plural, named after the model they manipulate.
$paginate public

array

Settings for pagination.
$passedArgs public deprecated

array

Holds all passed params.
$plugin protected

string|null

Automatically set to the name of a plugin.
$request public

Cake\Http\ServerRequest

An instance of a \Cake\Http\ServerRequest 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\Http\Response

An instance of a Response object that contains information about the impending response
$viewClass public deprecated

string|null

The name of default View class.
$viewVars public

array

Variables for the view.

Method Summary

__construct() public

Constructor.
__get() public

Magic accessor for model autoloading.
__set() public

Magic setter for removed properties.
_loadComponents() protected

Loads the defined components using the Component factory.
_mergeControllerVars() protected

Merge components, helpers vars from parent classes.
_mergeProperty() protected

Merge a single property with the values declared in all parent classes.
_mergePropertyData() protected

Merge each of the keys in a property together.
_mergeVars() protected

Merge the list of $properties with all parent classes of the current class.
_setModelClass() protected

Set the modelClass and modelKey properties based on conventions.
_viewPath() protected

Get the viewPath based on controller name and request prefix.
afterFilter() public

Called after the controller action is run and rendered.
beforeFilter() public

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() public

The beforeRedirect method is invoked when the controller's redirect method is called but before any further action.
beforeRender() public

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() public

Get the component registry for this controller.
createView() public

Constructs the view class instance based on the current configuration.
disableAutoRender() public

Disable automatic action rendering.
dispatchEvent() public

Wrapper for creating and dispatching events.
enableAutoRender() public

Enable automatic action rendering.
eventManager() public deprecated

Returns the Cake\Event\EventManager manager instance for this object.
getEventManager() public

Returns the Cake\Event\EventManager manager instance for this object.
getModelType() public

Get the model type to be used by this class
getName() public

Returns the controller name.
getPlugin() public

Returns the plugin name.
getRequest() public

Gets the request instance.
getResponse() public

Gets the response instance.
getTableLocator() public

Gets the table locator.
implementedEvents() public

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
initialize() public

Initialization hook method.
invokeAction() public

Dispatches the controller action. Checks that the action exists and isn't private.
isAction() public

Method to check that an action is accessible from a URL.
isAuthorized() public @method
isAutoRenderEnabled() public

Returns true if an action should be rendered automatically.
loadComponent() public

Add a component to the controller's registry.
loadModel() public

Loads and constructs repository objects required by this object
log() public

Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
modelFactory() public

Override a existing callable to generate repositories of a given type.
modelType() public deprecated

Set or get the model type to be used by this class
paginate() public

Handles pagination of records in Table objects.
redirect() public

Redirects to given $url, after turning off $this->autoRender.
referer() public

Returns the referring URL for this request.
render() public

Instantiates the correct view class, hands it its data, and uses it to render the view output.
requestAction() public deprecated

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.
set() public

Saves a variable or an associative array of variables for use inside a template.
setAction() public

Internally redirects one action to another. Does not perform another HTTP request unlike Controller::redirect()
setEventManager() public

Returns the Cake\Event\EventManager manager instance for this object.
setModelType() public

Set the model type to be used by this class
setName() public

Sets the controller name.
setPlugin() public

Sets the plugin name.
setRequest() public

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:
setResponse() public

Sets the response instance.
setTableLocator() public

Sets the table locator.
shutdownProcess() public

Perform the various shutdown processes for this controller. Fire the Components and Controller callbacks in the correct order.
startupProcess() public

Perform the startup process for this controller. Fire the Components and Controller callbacks in the correct order.
tableLocator() public deprecated

Sets the table locator. If no parameters are passed, it will return the currently used locator.
viewBuilder() public

Get the view builder being used.
viewOptions() public deprecated

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().

Method Detail

__construct() ¶ public

__construct(Cake\Http\ServerRequest|null $request = null, Cake\Http\Response|null $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.

Parameters

Cake\Http\ServerRequest|null $request optional: Request object for this controller. Can be null for testing, but expect that features that use the request parameters will not work.
Cake\Http\Response|null $response optional: Response object for this controller.
string|null $name optional: Override the name useful in testing when using mocks.
Cake\Event\EventManager|null $eventManager optional: The event manager. Defaults to a new instance.
Cake\Controller\ComponentRegistry|null $components optional: The component registry. Defaults to a new instance.

__get() ¶ public

__get(string $name): bool|object

Magic accessor for model autoloading.

Parameters

string $name: Property name

Returns

bool|object

__set() ¶ public

__set(string $name, mixed $value): void

Magic setter for removed properties.

Parameters

string $name: Property name.
mixed $value: Value to set.

Returns

void

_loadComponents() ¶ protected

_loadComponents(): void

Loads the defined components using the Component factory.

Returns

void

_mergeControllerVars() ¶ protected

_mergeControllerVars(): void

Merge components, helpers vars from parent classes.

Returns

void

_mergeProperty() ¶ protected

_mergeProperty(string $property, array $parentClasses, array $options): void

Merge a single property with the values declared in all parent classes.

Parameters

string $property: The name of the property being merged.
array $parentClasses: An array of classes you want to merge with.
array $options: Options for merging the property, see _mergeVars()

Returns

void

_mergePropertyData() ¶ protected

_mergePropertyData(array $current, array $parent, bool $isAssoc): mixed

Merge each of the keys in a property together.

Parameters

array $current: The current merged value.
array $parent: The parent class' value.
bool $isAssoc: Whether or not the merging should be done in associative mode.

Returns

mixed

_mergeVars() ¶ protected

_mergeVars(string[] $properties, array $options = []): void

Merge the list of $properties with all parent classes of the current class.

Options:

associative - A list of properties that should be treated as associative arrays. Properties in this list will be passed through Hash::normalize() before merging.

Parameters

string[] $properties: An array of properties and the merge strategy for them.
array $options optional: The options to use when merging properties.

Returns

void

_setModelClass() ¶ protected

_setModelClass(string $name): void

Set the modelClass and modelKey properties based on conventions.

If the properties are already set they will not be overwritten

Parameters

string $name: Class name.

Returns

void

_viewPath() ¶ protected

_viewPath(): string

Get the viewPath based on controller name and request prefix.

Returns

string

afterFilter() ¶ public

afterFilter(Cake\Event\Event $event): Cake\Http\Response|null

Called after the controller action is run and rendered.

Parameters

Cake\Event\Event $event: An Event instance

Returns

Cake\Http\Response|null

Links

https://book.cakephp.org/3/en/controllers.html#request-life-cycle-callbacks

beforeFilter() ¶ public

beforeFilter(Cake\Event\Event $event): Cake\Http\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.

Parameters

Cake\Event\Event $event: An Event instance

Returns

Cake\Http\Response|null

Links

https://book.cakephp.org/3/en/controllers.html#request-life-cycle-callbacks

beforeRedirect() ¶ public

beforeRedirect(Cake\Event\Event $event, string|array $url, Cake\Http\Response $response): Cake\Http\Response|null

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.

Parameters

Cake\Event\Event $event: An Event instance
string|array $url: A string or array-based URL pointing to another location within the app, or an absolute URL
Cake\Http\Response $response: The response object.

Returns

Cake\Http\Response|null

Links

https://book.cakephp.org/3/en/controllers.html#request-life-cycle-callbacks

beforeRender() ¶ public

beforeRender(Cake\Event\Event $event): Cake\Http\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.

Parameters

Cake\Event\Event $event: An Event instance

Returns

Cake\Http\Response|null

Links

https://book.cakephp.org/3/en/controllers.html#request-life-cycle-callbacks

components() ¶ public

components(Cake\Controller\ComponentRegistry|null $components = null): Cake\Controller\ComponentRegistry

Get the component registry for this controller.

If called with the first parameter, it will be set as the controller $this->_components property

Parameters

Cake\Controller\ComponentRegistry|null $components optional: Component registry.

Returns

Cake\Controller\ComponentRegistry

createView() ¶ public

createView(string|null $viewClass = null): Cake\View\View

Constructs the view class instance based on the current configuration.

Parameters

string|null $viewClass optional: Optional namespaced class name of the View class to instantiate.

Returns

Cake\View\View

Throws

Cake\View\Exception\MissingViewException
If view class was not found.

disableAutoRender() ¶ public

disableAutoRender(): $this

Disable automatic action rendering.

Returns

$this

dispatchEvent() ¶ public

dispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\Event

Wrapper 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\Event

enableAutoRender() ¶ public

enableAutoRender(): $this

Enable automatic action rendering.

Returns

$this

eventManager() ¶ public

eventManager(Cake\Event\EventManager|null $eventManager = null): Cake\Event\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|null $eventManager optional: the eventManager to set

Returns

Cake\Event\EventManager

getEventManager() ¶ public

getEventManager(): Cake\Event\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.

Returns

Cake\Event\EventManager

getModelType() ¶ public

getModelType(): string

Get the model type to be used by this class

Returns

string

getName() ¶ public

getName(): string

Returns the controller name.

Returns

string

getPlugin() ¶ public

getPlugin(): string|null

Returns the plugin name.

Returns

string|null

getRequest() ¶ public

getRequest(): Cake\Http\ServerRequest

Gets the request instance.

Returns

Cake\Http\ServerRequest

getResponse() ¶ public

getResponse(): Cake\Http\Response

Gets the response instance.

Returns

Cake\Http\Response

getTableLocator() ¶ public

getTableLocator(): Cake\ORM\Locator\LocatorInterface

Gets the table locator.

Returns

Cake\ORM\Locator\LocatorInterface

implementedEvents() ¶ public

implementedEvents(): array

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

Example:

 public function implementedEvents()
 {
     return [
         'Order.complete' => 'sendEmail',
         'Article.afterBuy' => 'decrementInventory',
         'User.onRegister' => ['callable' => 'logRegistration', 'priority' => 20, 'passParams' => true]
     ];
 }

Returns

array

initialize() ¶ public

initialize(): void

Initialization hook method.

Implement this method to avoid having to overwrite the constructor and call parent.

Returns

void

invokeAction() ¶ public

invokeAction(): mixed

Dispatches the controller action. Checks that the action exists and isn't private.

Returns

mixed

Throws

ReflectionException

isAction() ¶ public

isAction(string $action): bool

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.

Parameters

string $action: The action to check.

Returns

bool

Throws

ReflectionException

isAuthorized() ¶ public @method

isAuthorized(mixed $user): bool

Parameters

$user

Returns

bool

isAutoRenderEnabled() ¶ public

isAutoRenderEnabled(): bool

Returns true if an action should be rendered automatically.

Returns

bool

loadComponent() ¶ public

loadComponent(string $name, array $config = []): Cake\Controller\Component

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.

Parameters

string $name: The name of the component to load.
array $config optional: The config for the component.

Returns

Cake\Controller\Component

Throws

Exception

loadModel() ¶ public

loadModel(string|null $modelClass = null, string|null $modelType = null): Cake\Datasource\RepositoryInterface

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.

Parameters

string|null $modelClass optional: Name of model class to load. Defaults to $this->modelClass. The name can be an alias like 'Post' or FQCN like App\Model\Table\PostsTable::class.
string|null $modelType optional: The type of repository to load. Defaults to the modelType() value.

Returns

Cake\Datasource\RepositoryInterface

Throws

Cake\Datasource\Exception\MissingModelException
If the model class cannot be found.
InvalidArgumentException
When using a type that has not been registered.
UnexpectedValueException
If no model type has been defined

log() ¶ public

log(mixed $message, int|string $level = LogLevel::ERROR, string|array $context = []): bool

Convenience method to write a message to Log. See Log::write() for more information on writing to logs.

Parameters

mixed $message: Log message.
int|string $level optional: Error level.
string|array $context optional: Additional log data relevant to this message.

Returns

bool

modelFactory() ¶ public

modelFactory(string $type, callable $factory): void

Override a existing callable to generate repositories of a given type.

Parameters

string $type: The name of the repository type the factory function is for.
callable $factory: The factory function used to create instances.

Returns

void

modelType() ¶ public

modelType(string|null $modelType = null): string|$this

Set or get the model type to be used by this class

Parameters

string|null $modelType optional: The model type or null to retrieve the current

Returns

string|$this

paginate() ¶ public

paginate(Cake\ORM\Table|stringCake\ORM\Query|null $object = null, array $settings = []): Cake\ORM\ResultSetCake\Datasource\ResultSetInterface

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.

Parameters

Cake\ORM\Table|stringCake\ORM\Query|null $object optional: Table to paginate (e.g: Table instance, 'TableName' or a Query object)
array $settings optional: The settings/configuration used for pagination.

Returns

Cake\ORM\ResultSetCake\Datasource\ResultSetInterface

Throws

RuntimeException
When no compatible table object can be found.

Links

https://book.cakephp.org/3/en/controllers.html#paginating-a-model

redirect() ¶ public

redirect(string|arrayPsr\Http\Message\UriInterface $url, int $status = 302): Cake\Http\Response|null

Redirects to given $url, after turning off $this->autoRender.

Parameters

string|arrayPsr\Http\Message\UriInterface $url: A string, array-based URL or UriInterface instance.
int $status optional: HTTP status code. Defaults to 302.

Returns

Cake\Http\Response|null

Links

https://book.cakephp.org/3/en/controllers.html#Controller::redirect

referer() ¶ public

referer(string|array|null $default = null, bool $local = false): string

Returns the referring URL for this request.

Parameters

string|array|null $default optional: Default URL to use if HTTP_REFERER cannot be read from headers
bool $local optional: If true, restrict referring URLs to local server

Returns

string

render() ¶ public

render(string|null $view = null, string|null $layout = null): Cake\Http\Response

Instantiates the correct view class, hands it its data, and uses it to render the view output.

Parameters

string|null $view optional: View to use for rendering
string|null $layout optional: Layout to use

Returns

Cake\Http\Response

Links

https://book.cakephp.org/3/en/controllers.html#rendering-a-view

requestAction() ¶ public

requestAction(string|array $url, array $extra = []): mixed

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()

Examples

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']);

Passing other request data

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],
]);

Sending environment or header values

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']
]);

Transmitting the session

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)
]);

Parameters

string|array $url: String or array-based url. Unlike other url arrays in CakePHP, this url will not automatically handle passed arguments in the $url parameter.
array $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.

Returns

mixed

set() ¶ public

set(string|array $name, mixed $value = null): $this

Saves a variable or an associative array of variables for use inside a template.

Parameters

string|array $name: A string or an array of data.
mixed $value optional: 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.

Returns

$this

setAction() ¶ public

setAction(string $action, array ...$args): mixed

Internally redirects one action to another. Does not perform another HTTP request unlike Controller::redirect()

Examples:

setAction('another_action');
setAction('action_with_parameters', $parameter1);

Parameters

string $action: The new action to be 'redirected' to. Any other parameters passed to this method will be passed as parameters to the new action.
array ...$args: Arguments passed to the action

Returns

mixed

setEventManager() ¶ public

setEventManager(Cake\Event\EventManager $eventManager): $this

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

setModelType() ¶ public

setModelType(string $modelType): $this

Set the model type to be used by this class

Parameters

string $modelType: The model type

Returns

$this

setName() ¶ public

setName(string $name): $this

Sets the controller name.

Parameters

string $name: Controller name.

Returns

$this

setPlugin() ¶ public

setPlugin(string $name): $this

Sets the plugin name.

Parameters

string $name: Plugin name.

Returns

$this

setRequest() ¶ public

setRequest(Cake\Http\ServerRequest $request): $this

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:

$this->request - To the $request parameter
$this->passedArgs - Same as $request->params['pass]

Parameters

Cake\Http\ServerRequest $request: Request instance.

Returns

$this

setResponse() ¶ public

setResponse(Cake\Http\Response $response): $this

Sets the response instance.

Parameters

Cake\Http\Response $response: Response instance.

Returns

$this

setTableLocator() ¶ public

setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this

Sets the table locator.

Parameters

Cake\ORM\Locator\LocatorInterface $tableLocator: LocatorInterface instance.

Returns

$this

shutdownProcess() ¶ public

shutdownProcess(): Cake\Http\Response|null

Perform the various shutdown processes for this controller. Fire the Components and Controller callbacks in the correct order.

triggers the component shutdown callback.
calls the Controller's afterFilter method.

Returns

Cake\Http\Response|null

startupProcess() ¶ public

startupProcess(): Cake\Http\Response|null

Perform the startup process for this controller. Fire the Components and Controller callbacks in the correct order.

Initializes components, which fires their initialize callback
Calls the controller beforeFilter.
triggers Component startup methods.

Returns

Cake\Http\Response|null

tableLocator() ¶ public

tableLocator(Cake\ORM\Locator\LocatorInterface|null $tableLocator = null): Cake\ORM\Locator\LocatorInterface

Sets the table locator. If no parameters are passed, it will return the currently used locator.

Parameters

Cake\ORM\Locator\LocatorInterface|null $tableLocator optional: LocatorInterface instance.

Returns

Cake\ORM\Locator\LocatorInterface

viewBuilder() ¶ public

viewBuilder(): Cake\View\ViewBuilder

Get the view builder being used.

Returns

Cake\View\ViewBuilder

viewOptions() ¶ public

viewOptions(string|array|null $options = null, bool $merge = true): array

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().

Parameters

string|array|null $options optional: string or array of string to be appended to _validViewOptions.
bool $merge optional: Whether to merge with or override existing valid View options. Defaults to true.

Returns

array

Property Detail

`$Auth` ¶ public @property

Type

Cake\Controller\Component\AuthComponent

`$Cookie` ¶ public @property

Type

Cake\Controller\Component\CookieComponent

`$Csrf` ¶ public @property

Type

Cake\Controller\Component\CsrfComponent

`$Flash` ¶ public @property

Type

Cake\Controller\Component\FlashComponent

`$Paginator` ¶ public @property

Type

Cake\Controller\Component\PaginatorComponent

`$RequestHandler` ¶ public @property

Type

Cake\Controller\Component\RequestHandlerComponent

`$Security` ¶ public @property

Type

Cake\Controller\Component\SecurityComponent

`$View` ¶ public deprecated

Instance of the View created during rendering. Won't be set until after Controller::render() is called.

Type

Cake\View\View

`$_components` ¶ protected

Instance of ComponentRegistry used to create Components

Type

Cake\Controller\ComponentRegistry

`$_eventClass` ¶ protected

Default class name for new event objects.

Type

string

`$_eventManager` ¶ protected

Instance of the Cake\Event\EventManager this object is using to dispatch inner events.

Type

Cake\Event\EventManagerInterfaceCake\Event\EventManager

`$_modelFactories` ¶ protected

A list of overridden model factory functions.

Type

array

`$_modelType` ¶ protected

The model type to use.

Type

string

`$_responseClass` ¶ protected

The class name to use for creating the response object.

Type

string

`$_tableLocator` ¶ protected

Table locator instance

Type

Cake\ORM\Locator\LocatorInterface

`$_validViewOptions` ¶ protected deprecated

These Controller properties will be passed from the Controller to the View as options.

Type

array

`$_viewBuilder` ¶ protected

The view builder instance being used.

Type

Cake\View\ViewBuilder

`$autoRender` ¶ protected

Set to true to automatically render the view after action logic.

Type

bool

`$components` ¶ public deprecated

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'];

Type

array

`$helpers` ¶ public deprecated

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'];

Type

array

`$modelClass` ¶ public

This object's primary model class name. Should be a plural form. CakePHP will not inflect the name.

Example: For an object named 'Comments', the modelClass would be 'Comments'. Plugin classes should use Plugin.Comments style names to correctly load models from the correct plugin.

Use false to not use auto-loading on this object. Null auto-detects based on controller name.

Type

string|false|null

`$name` ¶ protected

The name of this controller. Controller names are plural, named after the model they manipulate.

Set automatically using conventions in Controller::__construct().

Type

string

`$paginate` ¶ public

Settings for pagination.

Used to pre-configure pagination preferences for the various tables your controller will be paginating.

Type

array

`$passedArgs` ¶ public deprecated

Holds all passed params.

Type

array

`$plugin` ¶ protected

Automatically set to the name of a plugin.

Type

string|null

`$request` ¶ public

An instance of a \Cake\Http\ServerRequest 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.

Deprecated 3.6.0: The property will become protected in 4.0.0. Use getRequest()/setRequest instead.

Type

Cake\Http\ServerRequest

`$response` ¶ public

An instance of a Response object that contains information about the impending response

Deprecated 3.6.0: The property will become protected in 4.0.0. Use getResponse()/setResponse instead.

Type

Cake\Http\Response

`$viewClass` ¶ public deprecated

The name of default View class.

Type

string|null

`$viewVars` ¶ public

Variables for the view.

Deprecated: This property will be removed in 4.x. Inside controller context use $this->set() instead, also see $this->viewBuilder()->getVar(). In view context it will be a protected property View::$viewVars.

Type

array

Namespaces

Class Controller

Life cycle callbacks

Property Summary

Method Summary

__construct() public

__get() public

__set() public

_loadComponents() protected

_mergeControllerVars() protected

_mergeProperty() protected

_mergePropertyData() protected

_mergeVars() protected

_setModelClass() protected

_viewPath() protected

afterFilter() public

beforeFilter() public

beforeRedirect() public

beforeRender() public

components() public

createView() public

disableAutoRender() public

dispatchEvent() public

enableAutoRender() public

eventManager() public deprecated

getEventManager() public

getModelType() public

getName() public

getPlugin() public

getRequest() public

getResponse() public

getTableLocator() public

implementedEvents() public

initialize() public

invokeAction() public

isAction() public

isAuthorized() public @method

isAutoRenderEnabled() public

loadComponent() public

loadModel() public

log() public

modelFactory() public

modelType() public deprecated

paginate() public

redirect() public

referer() public

render() public

requestAction() public deprecated

set() public

setAction() public

setEventManager() public

setModelType() public

setName() public

setPlugin() public

setRequest() public

setResponse() public

setTableLocator() public

shutdownProcess() public

startupProcess() public

tableLocator() public deprecated

viewBuilder() public

viewOptions() public deprecated

Method Detail

__construct() ¶ public

Parameters

__get() ¶ public

Parameters

Returns

__set() ¶ public

Parameters

Returns

_loadComponents() ¶ protected

Returns

_mergeControllerVars() ¶ protected

Returns

_mergeProperty() ¶ protected

Parameters

Returns

_mergePropertyData() ¶ protected

Parameters