Cell base.
$modelClass : string
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.
$_eventManager : \Cake\Event\EventManagerInterface|\Cake\Event\EventManager
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
$_tableLocator : \Cake\ORM\Locator\LocatorInterface
Table locator instance
$_viewBuilder : \Cake\View\ViewBuilder
The view builder instance being used.
$View : \Cake\View\View
Instance of the View created during rendering. Won't be set until after Cell::__toString()/render() is called.
$request : \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 : \Cake\Http\Response
An instance of a Response object that contains information about the impending response
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.
| \Cake\Event\EventManager|null | $eventManager | the eventManager to set |
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.
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.
| \Cake\Event\EventManager | $eventManager | the eventManager to set |
dispatchEvent(string $name, array|null $data = null, object|null $subject = null) : \Cake\Event\Event
Wrapper for creating and dispatching events.
Returns a dispatched event.
| string | $name | Name of the event. |
| array|null | $data | Any value you wish to be transported with this event to it can be read by listeners. |
| object|null | $subject | The object that this event applies to ($this by default). |
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.
| \Cake\ORM\Locator\LocatorInterface|null | $tableLocator | LocatorInterface instance. |
setTableLocator(\Cake\ORM\Locator\LocatorInterface $tableLocator) : $this
Sets the table locator.
| \Cake\ORM\Locator\LocatorInterface | $tableLocator | LocatorInterface instance. |
getTableLocator() : \Cake\ORM\Locator\LocatorInterface
Gets the table locator.
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.
| string|null | $modelClass | Name of model class to load. Defaults to $this->modelClass |
| string|null | $modelType | The type of repository to load. Defaults to the modelType() value. |
If the model class cannot be found.
When using a type that has not been registered.
If no model type has been defined
The model instance created.
viewBuilder() : \Cake\View\ViewBuilder
Get the view builder being used.
createView(string|null $viewClass = null) : \Cake\View\View
Constructs the view class instance based on the current configuration.
| string|null | $viewClass | Optional namespaced class name of the View class to instantiate. |
If view class was not found.
set(string|array $name, mixed $value = null) : $this
Saves a variable or an associative array of variables for use inside a template.
| string|array | $name | A string or an array of data. |
| mixed | $value | 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. |
viewOptions(string|array|null $options = null, boolean $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()`.
| string|array|null | $options | string or array of string to be appended to _validViewOptions. |
| boolean | $merge | Whether to merge with or override existing valid View options.
Defaults to |
The updated view options as an array.
__construct(\Cake\Http\ServerRequest|null $request = null, \Cake\Http\Response|null $response = null, \Cake\Event\EventManager|null $eventManager = null, array $cellOptions = array())
Constructor.
| \Cake\Http\ServerRequest|null | $request | The request to use in the cell. |
| \Cake\Http\Response|null | $response | The response to use in the cell. |
| \Cake\Event\EventManager|null | $eventManager | The eventManager to bind events to. |
| array | $cellOptions | Cell options to apply. |
render(string|null $template = null) : string
Render the cell.
| string|null | $template | Custom template name to render. If not provided (null), the last
value will be used. This value is automatically set by |
When a MissingTemplateException is raised during rendering.
The rendered cell.
__toString() : string
Magic method.
Starts the rendering process when Cell is echoed.
Note This method will trigger an error when view rendering has a problem. This is because PHP will not allow a __toString() method to throw an exception.
Include error details for PHP 7 fatal errors.
Rendered cell
_cacheConfig(string $action, string|null $template = null) : array
Generate the cache key to use for this cell.
If the key is undefined, the cell class and action name will be used.
| string | $action | The action invoked. |
| string|null | $template | The name of the template to be rendered. |
The cache configuration.