Class Cell
Cell base.
Property Summary
-
$View public deprecated
Cake\View\ViewInstance of the View created during rendering. Won't be set until after Cell::__toString() is called.
-
$_cache protected
array|boolCaching setup.
-
$_eventClass protected
stringDefault class name for new event objects.
-
$_eventManager protected
Cake\Event\EventManagerInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
-
$_modelFactories protected
arrayA list of overridden model factory functions.
-
$_modelType protected
stringThe model type to use.
-
$_tableLocator protected
Cake\ORM\Locator\LocatorInterfaceTable locator instance
-
$_validCellOptions protected
arrayList of valid options (constructor's fourth arguments) Override this property in subclasses to whitelist which options you want set as properties in your Cell.
-
$_validViewOptions protected
arrayThese properties can be set directly on Cell and passed to the View as options.
-
$_viewBuilder protected
Cake\View\ViewBuilderThe view builder instance being used.
-
$action public
stringThe cell's action to invoke.
-
$args public
arrayArguments to pass to cell's action.
-
$helpers public
arrayThe helpers this cell uses.
-
$modelClass public
stringThis object's primary model class name. Should be a plural form. CakePHP will not inflect the name.
-
$plugin public
stringAutomatically set to the name of a plugin.
-
$request public
Cake\Network\RequestAn 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\ResponseAn instance of a Response object that contains information about the impending response
-
$template public
stringName of the template that will be rendered. This property is inflected from the action name that was invoked.
-
$viewClass public deprecated
stringThe name of default View class.
-
$viewVars public
arrayVariables for the view
Method Summary
-
__construct() public
Constructor.
-
__debugInfo() public
Debug info.
-
__toString() public
Magic method.
-
_cacheConfig() protected
Generate the cache key to use for this cell.
-
_setModelClass() protected
Set the modelClass and modelKey properties based on conventions.
-
createView() public
Constructs the view class instance based on the current configuration.
-
dispatchEvent() public
Wrapper for creating and dispatching events.
-
eventManager() public
Returns the Cake\Event\EventManager manager instance for this object.
-
loadModel() public
Loads and constructs repository objects required by this object
-
modelFactory() public
Override a existing callable to generate repositories of a given type.
-
modelType() public
Set or get the model type to be used by this class
-
render() public
Render the cell.
-
set() public
Saves a variable or an associative array of variables for use inside a template.
-
tableLocator() public
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
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\Network\Request|null $request = null, Cake\Network\Response|null $response = null, Cake\Event\EventManager|null $eventManager = null, array $cellOptions = [])Constructor.
Parameters
-
Cake\Network\Request|null$request optional The request to use in the cell.
-
Cake\Network\Response|null$response optional The response to use in the cell.
-
Cake\Event\EventManager|null$eventManager optional The eventManager to bind events to.
-
array$cellOptions optional Cell options to apply.
__toString() ¶ public
__toString(): stringMagic 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.
Returns
stringRendered cell
Throws
ErrorInclude error details for PHP 7 fatal errors.
_cacheConfig() ¶ protected
_cacheConfig(string $action, string|null $template = null): arrayGenerate the cache key to use for this cell.
If the key is undefined, the cell class and action name will be used.
Parameters
-
string$action The action invoked.
-
string|null$template optional The name of the template to be rendered.
Returns
arrayThe cache configuration.
_setModelClass() ¶ protected
_setModelClass(string $name): voidSet 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
voidcreateView() ¶ public
createView(string|null $viewClass = null): Cake\View\ViewConstructs 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\ViewThrows
Cake\View\Exception\MissingViewExceptionIf view class was not found.
dispatchEvent() ¶ public
dispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventWrapper 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\EventeventManager() ¶ public
eventManager(Cake\Event\EventManager|null $eventManager = null): Cake\Event\EventManagerReturns 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\EventManagerloadModel() ¶ public
loadModel(string|null $modelClass = null, string|null $modelType = null): Cake\Datasource\RepositoryInterfaceLoads 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
-
string|null$modelType optional The type of repository to load. Defaults to the modelType() value.
Returns
Cake\Datasource\RepositoryInterfaceThe model instance created.
Throws
Cake\Datasource\Exception\MissingModelExceptionIf the model class cannot be found.
InvalidArgumentExceptionWhen using a type that has not been registered.
UnexpectedValueExceptionIf no model type has been defined
modelFactory() ¶ public
modelFactory(string $type, callable $factory): voidOverride 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
voidmodelType() ¶ public
modelType(string|null $modelType = null): string|$thisSet 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|$thisrender() ¶ public
render(string|null $template = null): stringRender the cell.
Parameters
-
string|null$template optional Custom template name to render. If not provided (null), the last value will be used. This value is automatically set by
CellTrait::cell().
Returns
stringThe rendered cell.
Throws
Cake\View\Exception\MissingCellViewExceptionWhen a MissingTemplateException is raised during rendering.
set() ¶ public
set(string|array $name, mixed $value = null): $thisSaves 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
$thistableLocator() ¶ public
tableLocator(Cake\ORM\Locator\LocatorInterface|null $tableLocator = null): Cake\ORM\Locator\LocatorInterfaceSets 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\LocatorInterfaceviewBuilder() ¶ public
viewBuilder(): Cake\View\ViewBuilderGet the view builder being used.
Returns
Cake\View\ViewBuilderviewOptions() ¶ public
viewOptions(string|array|null $options = null, bool $merge = true): arrayGet/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
arrayThe updated view options as an array.
Property Detail
$View ¶ public deprecated
Instance of the View created during rendering. Won't be set until after Cell::__toString() is called.
Type
Cake\View\View$_eventManager ¶ protected
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
Type
Cake\Event\EventManager$_validCellOptions ¶ protected
List of valid options (constructor's fourth arguments) Override this property in subclasses to whitelist which options you want set as properties in your Cell.
Type
array$_validViewOptions ¶ protected
These properties can be set directly on Cell and passed to the View as options.
Type
array$helpers ¶ public
The helpers this cell uses.
This property is copied automatically when using the CellTrait
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.
Type
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.
Type
Cake\Network\Request$response ¶ public
An instance of a Response object that contains information about the impending response
Type
Cake\Network\Response$template ¶ public
Name of the template that will be rendered. This property is inflected from the action name that was invoked.
Type
string