Class Cell
Cell base.
Constants
-
stringTEMPLATE_FOLDER ¶'cell'Constant for folder name containing cell templates.
Property Summary
-
$View protected
Cake\View\ViewInstance of the View created during rendering. Won't be set until after Cell::__toString()/render() is called.
-
$_cache protected
array|boolCaching setup.
-
$_eventClass protected
stringDefault class name for new event objects.
-
$_eventManager protected
Cake\Event\EventManagerInterface|nullInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
-
$_modelFactories protected
array<callable|Cake\Datasource\Locator\LocatorInterface>A list of overridden model factory functions.
-
$_modelType protected
stringThe model type to use.
-
$_tableLocator protected
Cake\ORM\Locator\LocatorInterface|nullTable locator instance
-
$_validCellOptions protected
array<string>List of valid options (constructor's fourth arguments) Override this property in subclasses to allow which options you want set as properties in your Cell.
-
$_viewBuilder protected
Cake\View\ViewBuilder|nullThe view builder instance being used.
-
$action protected
stringThe cell's action to invoke.
-
$args protected
arrayArguments to pass to cell's action.
-
$defaultTable protected
string|nullThis object's default table alias.
-
$modelClass protected
string|nullThis object's primary model class name. Should be a plural form. CakePHP will not inflect the name.
-
$request protected
Cake\Http\ServerRequestAn 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 protected
Cake\Http\ResponseAn instance of a Response object that contains information about the impending response
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 property based on conventions.
-
createView() public
Constructs the view class instance based on the current configuration.
-
dispatchEvent() public
Wrapper for creating and dispatching events.
-
fetchModel() public
Fetch or construct a model instance from a locator.
-
fetchTable() public
Convenience method to get a table instance.
-
getEventManager() public
Returns the Cake\Event\EventManager manager instance for this object.
-
getModelType() public
Get the model type to be used by this class
-
getTableLocator() public
Gets the table locator.
-
initialize() public
Initialization hook method.
-
loadModel() public deprecated
Fetch or construct a model and set it to a property on this object.
-
modelFactory() public
Override a existing callable to generate repositories of a given type.
-
render() public
Render the cell.
-
set() public
Saves a variable or an associative array of variables for use inside a template.
-
setEventManager() public
Returns the Cake\Event\EventManagerInterface instance for this object.
-
setModelType() public
Set the model type to be used by this class
-
setTableLocator() public
Sets the table locator.
-
viewBuilder() public
Get the view builder being used.
Method Detail
__construct() ¶ public
__construct(Cake\Http\ServerRequest $request, Cake\Http\Response $response, Cake\Event\EventManagerInterface|null $eventManager = null, array<string, mixed> $cellOptions = [])Constructor.
Parameters
-
Cake\Http\ServerRequest$request The request to use in the cell.
-
Cake\Http\Response$response The response to use in the cell.
-
Cake\Event\EventManagerInterface|null$eventManager optional The eventManager to bind events to.
-
array<string, mixed>$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
stringThrows
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
array_setModelClass() ¶ protected
_setModelClass(string $name): voidSet the modelClass property based on conventions.
If the property is already set it 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\EventInterfaceWrapper 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\EventInterfacefetchModel() ¶ public
fetchModel(string|null $modelClass = null, string|null $modelType = null): Cake\Datasource\RepositoryInterfaceFetch or construct a model instance from a locator.
Uses a modelFactory based on $modelType to fetch and construct a RepositoryInterface
and return it. The default modelType can be defined with setModelType().
Unlike loadModel() this method will not set an object property.
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 likeApp\Model\Table\PostsTable::class.-
string|null$modelType optional The type of repository to load. Defaults to the getModelType() value.
Returns
Cake\Datasource\RepositoryInterfaceThrows
Cake\Datasource\Exception\MissingModelExceptionIf the model class cannot be found.
UnexpectedValueExceptionIf $modelClass argument is not provided and ModelAwareTrait::$modelClass property value is empty.
fetchTable() ¶ public
fetchTable(string|null $alias = null, array<string, mixed> $options = []): Cake\ORM\TableConvenience method to get a table instance.
Parameters
-
string|null$alias optional The alias name you want to get. Should be in CamelCase format. If
nullthen the value of $defaultTable property is used.-
array<string, mixed>$options optional The options you want to build the table with. If a table has already been loaded the registry options will be ignored.
Returns
Cake\ORM\TableThrows
Cake\Core\Exception\CakeExceptionIf `$alias` argument and `$defaultTable` property both are `null`.
See Also
getEventManager() ¶ public
getEventManager(): Cake\Event\EventManagerInterfaceReturns 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\EventManagerInterfacegetModelType() ¶ public
getModelType(): stringGet the model type to be used by this class
Returns
stringgetTableLocator() ¶ public
getTableLocator(): Cake\ORM\Locator\LocatorInterfaceGets the table locator.
Returns
Cake\ORM\Locator\LocatorInterfaceinitialize() ¶ public
initialize(): voidInitialization hook method.
Implement this method to avoid having to overwrite the constructor and calling parent::__construct().
Returns
voidloadModel() ¶ public
loadModel(string|null $modelClass = null, string|null $modelType = null): Cake\Datasource\RepositoryInterfaceFetch or construct a model and set it to a property on this object.
Uses a modelFactory based on $modelType to fetch and construct a RepositoryInterface
and set it as a property on the current object. The default modelType
can be defined with setModelType().
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 likeApp\Model\Table\PostsTable::class.-
string|null$modelType optional The type of repository to load. Defaults to the getModelType() value.
Returns
Cake\Datasource\RepositoryInterfaceThrows
Cake\Datasource\Exception\MissingModelExceptionIf the model class cannot be found.
UnexpectedValueExceptionIf $modelClass argument is not provided and ModelAwareTrait::$modelClass property value is empty.
modelFactory() ¶ public
modelFactory(string $type, Cake\Datasource\Locator\LocatorInterface|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.
-
Cake\Datasource\Locator\LocatorInterface|callable$factory The factory function used to create instances.
Returns
voidrender() ¶ 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
stringThrows
Cake\View\Exception\MissingCellTemplateExceptionBadMethodCallExceptionset() ¶ public
set(array|string $name, mixed $value = null): $thisSaves a variable or an associative array of variables for use inside a template.
Parameters
-
array|string$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
$thissetEventManager() ¶ public
setEventManager(Cake\Event\EventManagerInterface $eventManager): $thisReturns the Cake\Event\EventManagerInterface 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\EventManagerInterface$eventManager the eventManager to set
Returns
$thissetModelType() ¶ public
setModelType(string $modelType): $thisSet the model type to be used by this class
Parameters
-
string$modelType The model type
Returns
$thissetTableLocator() ¶ public
setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $thisSets the table locator.
Parameters
-
Cake\ORM\Locator\LocatorInterface$tableLocator LocatorInterface instance.
Returns
$thisviewBuilder() ¶ public
viewBuilder(): Cake\View\ViewBuilderGet the view builder being used.
Returns
Cake\View\ViewBuilderProperty Detail
$View ¶ protected
Instance of the View created during rendering. Won't be set until after Cell::__toString()/render() 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\EventManagerInterface|null$_modelFactories ¶ protected
A list of overridden model factory functions.
Type
array<callable|Cake\Datasource\Locator\LocatorInterface>$_validCellOptions ¶ protected
List of valid options (constructor's fourth arguments) Override this property in subclasses to allow which options you want set as properties in your Cell.
Type
array<string>$modelClass ¶ protected
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 empty string to not use auto-loading on this object. Null auto-detects based on controller name.
Type
string|null$request ¶ protected
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.
Type
Cake\Http\ServerRequest$response ¶ protected
An instance of a Response object that contains information about the impending response
Type
Cake\Http\Response