Spec-Zone.ru › CakePHP 3.8

Класс 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.

Примечание Этот метод вызовет ошибку, если произошла ошибка при рендеринге view. Это связано с тем, что 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
менеджер событий для установки

Возвращает

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
устанавливаемый менеджер событий

Возвращает


$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 на основе соглашений.

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

Параметры

строка $name
Имя класса.

getModelType()source public

getModelType( )

Получение типа модели, используемого этим классом.

Возвращает

строка

loadModel()source public

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

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

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

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

Параметры

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

Имя класса модели для загрузки. По умолчанию $this->modelClass. Имя может быть псевдонимом, как 'Post' или FQCN, как App\Model\Table\PostsTable::class.

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

Возвращает

Cake\Datasource\RepositoryInterface
Экземпляр созданной модели.

Исключения

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

modelFactory()source public

modelFactory( string $type , callable $factory )

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

Параметры

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

modelType()source public deprecated

modelType( string|null $modelType = null )

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

Устарело

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

Параметры

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

Возвращает

строка|Cake\Datasource\ModelAwareTrait
$this

setModelType()source public

setModelType( string $modelType )

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

Параметры

строка $modelType
Тип модели

Возвращает


$this

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

createView()source public

createView( string|null $viewClass = null )

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

Параметры

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

Возвращает

Cake\View\View

Исключения

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

set()source public

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

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

Параметры

строка|массив $name
Строка или массив данных.
смешанное $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() или любой из его методов-сеттеров вместо этого.

Параметры

строка|массив|null $options необязательно null
строка или массив строк, которые будут добавлены в _validViewOptions.
логическое значение $merge необязательно true

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

Возвращает

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

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

$Viewsource

protected Cake\View\View

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

$_cachesource

protected массив|логическое значение

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

false

$_validCellOptionssource

protected array

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

[]

$_validViewOptionssource

protected array

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

См.

Cake\View\View

Устаревшее

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

$actionsource

protected string

Действие элемента, которое нужно вызвать.

$argssource

protected array

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

[]

$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.8/class-Cake.View.Cell.html

Spec-Zone.ru

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