CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.10 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.10
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View
      • Exception
      • Form
      • Helper
      • Widget

Class Cell

Cell base.

Abstract
Namespace: Cake\View

Property Summary

  • $View protected
    Cake\View\View

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

  • $_cache protected
    array|bool

    Caching setup.

  • $_eventClass protected
    string

    Default class name for new event objects.

  • $_eventManager protected
    Cake\Event\EventManagerInterface|Cake\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.

  • $_tableLocator protected
    Cake\ORM\Locator\LocatorInterface

    Table locator instance

  • $_validCellOptions protected
    array

    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.

  • $_validViewOptions protected deprecated
    array

    These properties can be set directly on Cell and passed to the View as options.

  • $_viewBuilder protected
    Cake\View\ViewBuilder

    The view builder instance being used.

  • $action protected
    string

    The cell's action to invoke.

  • $args protected
    array

    Arguments to pass to cell's action.

  • $modelClass public
    string|false|null

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

  • $request protected
    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 protected
    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.

  • __debugInfo() public

    Debug info.

  • __get() public

    Magic accessor for removed properties.

  • __set() public

    Magic setter for removed properties.

  • __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 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

  • getTableLocator() public

    Gets the table locator.

  • initialize() public

    Initialization hook method.

  • 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 deprecated

    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.

  • setEventManager() public

    Returns the Cake\Event\EventManager manager instance for this object.

  • setModelType() public

    Set the model type to be used by this class

  • setTableLocator() public

    Sets the table locator.

  • 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, Cake\Event\EventManager|null $eventManager = null, array $cellOptions = [])

Constructor.

Parameters
Cake\Http\ServerRequest|null $request optional

The request to use in the cell.

Cake\Http\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.

__debugInfo() ¶ public

__debugInfo(): array

Debug info.

Returns
array

__get() ¶ public

__get(string $name): mixed

Magic accessor for removed properties.

Parameters
string $name

Property name

Returns
mixed

__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

__toString() ¶ public

__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.

Returns
string
Throws
Error
Include error details for PHP 7 fatal errors.

_cacheConfig() ¶ protected

_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.

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

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.

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

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

getTableLocator() ¶ public

getTableLocator(): Cake\ORM\Locator\LocatorInterface

Gets the table locator.

Returns
Cake\ORM\Locator\LocatorInterface

initialize() ¶ public

initialize(): void

Initialization hook method.

Implement this method to avoid having to overwrite the constructor and calling parent::__construct().

Returns
void

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

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

render() ¶ public

render(string|null $template = null): string

Render 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
string
Throws
Cake\View\Exception\MissingCellViewException
When a MissingTemplateException is raised during rendering.

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

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

setTableLocator() ¶ public

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

Sets the table locator.

Parameters
Cake\ORM\Locator\LocatorInterface $tableLocator

LocatorInterface instance.

Returns
$this

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

$View ¶ protected

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

Type
Cake\View\View

$_cache ¶ protected

Caching setup.

Type
array|bool

$_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\EventManagerInterface|Cake\Event\EventManager

$_modelFactories ¶ protected

A list of overridden model factory functions.

Type
array

$_modelType ¶ protected

The model type to use.

Type
string

$_tableLocator ¶ protected

Table locator instance

Type
Cake\ORM\Locator\LocatorInterface

$_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 deprecated

These properties can be set directly on Cell and passed to the View as options.

Type
array

$_viewBuilder ¶ protected

The view builder instance being used.

Type
Cake\View\ViewBuilder

$action ¶ protected

The cell's action to invoke.

Type
string

$args ¶ protected

Arguments to pass to cell's action.

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

$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

$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
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs