Spec-Zone.ru › CakePHP 3.7

Класс Cell

Базовый класс Cell.

Cake\View\Cell использует Cake\Event\EventDispatcherTrait , Cake\ORM\Locator\LocatorAwareTrait , Cake\Datasource\ModelAwareTrait , Cake\View\ViewVarsTrait
Абстрактный
Пространство имён: Cake\View
Расположение: View/Cell.php

Краткое описание свойств

  • $View protected
    Cake\View\View

    Экземпляр View, созданный во время рендеринга. Не будет установлен до вызова Cell::__toString()/render().

  • $_cache protected
    array|boolean
    Настройка кеширования.
  • $_validCellOptions protected
    array

    Список допустимых параметров (четвёртый аргумент конструктора). Переопределите это свойство в подклассах, чтобы указать, какие параметры вы хотите установить в качестве свойств своего Cell.

  • $_validViewOptions protected
    array
    Эти свойства могут быть установлены непосредственно в Cell и переданы в View в качестве параметров.
  • $action protected
    string
    Действие ячейки для вызова.
  • $args protected
    array
    Аргументы для передачи в действие ячейки.
  • $request protected
    Cake\Http\ServerRequest

    Экземпляр объекта Cake\Http\ServerRequest, содержащий информацию о текущем запросе. Этот объект содержит всю информацию о запросе и несколько методов для чтения дополнительной информации о запросе.

  • $response protected
    Cake\Http\Response
    Экземпляр объекта Response, содержащий информацию о предстоящем ответе.

Унаследованные магические свойства

  • _validViewOptions

Унаследованные свойства

  • _eventClass, _eventManager _tableLocator _modelFactories, _modelType, modelClass _viewBuilder, viewClass, viewVars

Краткое описание методов

  • __construct() public
    Конструктор.
  • __debugInfo() public
    Информация для отладки.
  • __get() public
    Магический метод доступа к удалённым свойствам.
  • __set() public
    Магический метод установки удалённых свойств.
  • __toString() public
    Магический метод.
  • _cacheConfig() protected
    Генерация ключа кеширования для этой ячейки.
  • initialize() public
    Метод инициализации.
  • render() public
    Рендеринг ячейки.

Подробное описание методов

__construct()source public

__construct( Cake\Http\ServerRequest $request = null , Cake\Http\Response $response = null , Cake\Event\EventManager $eventManager = null , array $cellOptions = [] )

Конструктор.

Параметры

Cake\Http\ServerRequest $request необязательный null
Запрос для использования в ячейке.
Cake\Http\Response $response необязательный null
Ответ для использования в ячейке.
Cake\Event\EventManager $eventManager необязательный null
EventManager для привязки событий.
массив $cellOptions необязательный []
Параметры ячейки для применения.

__debugInfo()source public

__debugInfo( )

Информация для отладки.

Возвращает

массив

__get()source public

__get( string $name )

Магический метод доступа к удалённым свойствам.

Параметры

строка $name
Имя свойства

Возвращает

смешанное

__set()source public

__set( string $name , mixed $value )

Магический метод установки удалённых свойств.

Параметры

строка $name
Имя свойства.
смешанное $value
Значение для установки.

__toString()source public

__toString( )

Магический метод.

Запускает процесс рендеринга при выводе Cell.

Примечание Этот метод вызовет ошибку при проблемах с рендерингом представления. Это происходит потому, что PHP не позволит методу __toString() генерировать исключения.

Возвращает

строка
Отрендеренная ячейка

Исключения

Ошибка
Подробная информация об ошибках PHP 7.

_cacheConfig()source protected

_cacheConfig( string $action , string|null $template = null )

Генерация ключа кеширования для этой ячейки.

Если ключ не определён, будут использованы имя класса ячейки и имя действия.

Параметры

строка $action
Вызванное действие.
строка|null $template необязательный null
Имя шаблона, который необходимо отрендерить.

Возвращает

массив
Конфигурация кеширования.

initialize()source public

initialize( )

Метод инициализации.

Реализуйте этот метод, чтобы избежать необходимости переопределять конструктор и вызывать parent::__construct().

render()source public

render( string|null $template = null )

Рендеринг ячейки.

Параметры

строка|null $template необязательный null

Пользовательское имя шаблона для рендеринга. Если не указано (null), будет использоваться последнее значение. Это значение автоматически устанавливается CellTrait::cell().

Возвращает

строка
Отрендеренная ячейка.

Исключения

Cake\View\Exception\MissingCellViewException
При возникновении MissingTemplateException во время рендеринга.

Методы, используемые из Cake\Event\EventDispatcherTrait

dispatchEvent()source public

dispatchEvent( string $name , array|null $data = null , object|null $subject = null )

Оборачивающий метод для создания и отправки событий.

Возвращает обработанное событие.

Параметры

строка $name
Имя события.
массив|null $data необязательный null

Любое значение, которое вы хотите передать с этим событием. Его могут прочитать слушатели.

объект|null $subject необязательный null

Объект, к которому относится это событие ($this по умолчанию).

Возвращает

Cake\Event\Event

eventManager()source public устаревший

eventManager( Cake\Event\EventManager $eventManager = null )

Возвращает экземпляр менеджера событий Cake\Event\EventManager для этого объекта.

Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов событий объекта, или создавать свои собственные события и вызывать их по желанию.

Устаревший

3.5.0 Используйте getEventManager()/setEventManager() вместо этого.

Параметры

Cake\Event\EventManager $eventManager необязательный null
устанавливаемый eventManager

Возвращает

Cake\Event\EventManager
END_OF_DOCUMENT_MARKER

getEventManager()source public

getEventManager( )

Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.

Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов на события объекта, или создавать собственные события и вызывать их по своему усмотрению.

Возвращает

Cake\Event\EventManager

setEventManager()source public

setEventManager( Cake\Event\EventManager $eventManager )

Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.

Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов на события объекта, или создавать собственные события и вызывать их по своему усмотрению.

Параметры

Cake\Event\EventManager $eventManager
устанавливаемый eventManager

Возвращает


$this

Методы, используемые из Cake\ORM\Locator\LocatorAwareTrait

getTableLocator()source public

getTableLocator( )

Получает локатор таблицы.

Возвращает

Cake\ORM\Locator\LocatorInterface

setTableLocator()source public

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

Устанавливает локатор таблицы.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator
Экземпляр LocatorInterface.

Возвращает


$this

tableLocator()source public deprecated

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

Устанавливает локатор таблицы. Если параметры не переданы, он вернёт текущий используемый локатор.

Устарело

3.5.0 Используйте getTableLocator()/setTableLocator() вместо этого.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator необязательно null
Экземпляр LocatorInterface.

Возвращает

Cake\ORM\Locator\LocatorInterface

Методы, используемые из Cake\Datasource\ModelAwareTrait

_setModelClass()source protected

_setModelClass( string $name )

Устанавливает свойства modelClass и modelKey на основе соглашений.

Если свойства уже установлены, они не будут перезаписаны.

Параметры

string $name
Имя класса.

getModelType()source public

getModelType( )

Получить тип модели, используемый этим классом

Возвращает

string

loadModel()source public

loadModel( string|null $modelClass = null , string|null $modelType = null )

Загружает и создаёт объекты репозитория, необходимые этому объекту

Обычно используется для загрузки объектов таблицы ORM, как требуется. Также может использоваться для загрузки других типов объектов репозитория, используемых вашим приложением.

Если поставщик репозитория не возвращает объект, будет выброшено MissingModelException.

Параметры

string|null $modelClass необязательно null
Имя класса модели для загрузки. По умолчанию $this->modelClass
string|null $modelType необязательно null
Тип репозитория для загрузки. По умолчанию значение modelType().

Возвращает

Cake\Datasource\RepositoryInterface
Созданный экземпляр модели.

Выбрасывает

Cake\Datasource\Exception\MissingModelException
Если класс модели не найден.
InvalidArgumentException
При использовании типа, который не зарегистрирован.
UnexpectedValueException
Если тип модели не определён

modelFactory()source public

modelFactory( string $type , callable $factory )

Переопределить существующую вызываемую функцию для генерации репозиториев заданного типа.

Параметры

string $type
Имя типа репозитория, для которого предназначена функция-фабрика.
callable $factory
Функция-фабрика, используемая для создания экземпляров.

modelType()source public deprecated

modelType( string|null $modelType = null )

Установить или получить тип модели, который будет использоваться этим классом

Устарело

3.5.0 Используйте getModelType()/setModelType() вместо этого.

Параметры

string|null $modelType необязательно null
Тип модели или null для получения текущего

Возвращает

string|Cake\Datasource\ModelAwareTrait
$this

setModelType()source public

setModelType( string $modelType )

Устанавливает тип модели, который будет использоваться этим классом

Параметры

string $modelType
Тип модели

Возвращает


$this

Методы, используемые из Cake\View\ViewVarsTrait

createView()source public

createView( string|null $viewClass = null )

Создаёт экземпляр класса представления на основе текущей конфигурации.

Параметры

string|null $viewClass необязательно null
Необязательное имя класса представления с пространством имён для создания экземпляра.

Возвращает

Cake\View\View

Выбрасывает

Cake\View\Exception\MissingViewException
Если класс представления не найден.

set()source public

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

Сохраняет переменную или ассоциативный массив переменных для использования внутри шаблона.

Параметры

string|array $name
Строка или массив данных.
mixed $value необязательно null

Значение в случае, если $name является строкой (которая затем работает как ключ). Не используется, если $name является ассоциативным массивом, в противном случае служит значениями ключей $name.

Возвращает


$this

viewBuilder()source public

viewBuilder( )

Получить используемый билдер представлений.

Возвращает

Cake\View\ViewBuilder

viewOptions()source public deprecated

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

Получить/установить допустимые параметры представления в свойстве объекта _validViewOptions. Свойство создаётся как пустой массив, если оно не установлено. Если вызывается без параметров, возвращает текущий список допустимых параметров представления. См. createView().

Устарело

3.7.0 Используйте ViewBuilder::setOptions() или любой из его методов-сеттеров вместо этого.

Параметры

string|array|null $options необязательно null
строка или массив строк, которые необходимо добавить к _validViewOptions.
boolean $merge необязательно true

Объединять или перезаписывать существующие допустимые параметры представлений. По умолчанию true.

Возвращает

array
Обновлённые параметры представления в виде массива.

Подробное описание свойств

$Viewsource

protected Cake\View\View

Экземпляр представления, созданный во время рендеринга. Не будет установлен до вызова Cell::__toString()/render().

$_cachesource

protected array|boolean

Настройка кэширования.

false

$_validCellOptionssource

protected массив

Список допустимых параметров (четвёртый аргумент конструктора) Переопределите этот параметр в подклассах, чтобы добавить в белый список параметры, которые вы хотите задать как свойства в вашем элементе.

[]

$_validViewOptionssource

protected массив

Эти свойства могут быть установлены непосредственно в элементе и переданы в представление в качестве параметров.

См.

Cake\View\View

Устарело

3.7.0 Используйте ViewBuilder::setOptions() или любой из его методов-сеттеров вместо этого.
[
    'viewPath'
]

$actionsource

protected строка

Действие элемента для вызова.

$argssource

protected массив

Аргументы для передачи действию элемента.

[]

$requestsource

protected Cake\Http\ServerRequest

Экземпляр объекта Cake\Http\ServerRequest, содержащий информацию об текущем запросе. Этот объект содержит всю информацию о запросе и несколько методов для чтения дополнительной информации о запросе.

$responsesource

protected Cake\Http\Response

Экземпляр объекта Response, содержащий информацию о предстоящем ответе

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.7/class-Cake.View.Cell.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API