Spec-Zone.ru › CakePHP 3.6

Класс Cell

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

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

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

  • $View public
    Cake\View\View

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

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

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

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

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

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

    Имя шаблона, который будет отрисован. Это свойство образуется из имени метода, вызвавшего действие.

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

  • _validViewOptions

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

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

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

  • __construct() public
    Конструктор.
  • __debugInfo() 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( )

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

Возвращает

массив

__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

getEventManager()source public

getEventManager( )

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

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

Возвращает

Cake\Event\EventManager
END_OF_DOCUMENT_MARKER

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

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

Параметры

строка $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
строка|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

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

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

Параметры

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

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

Возвращаемое значение

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

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

$Viewsource

public Cake\View\View

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

Устарело

3.1.0 Используйте createView() вместо этого.

$_cachesource

protected массив|boolean

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

false

$_validCellOptionssource

protected массив

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

[]

$_validViewOptionssource

protected массив

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

См.

Cake\View\View
[
    'viewPath'
]

$actionsource

public строка

Действие ячейки для вызова.

$argssource

public массив

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

[]

$helperssource

public массив

Помощники, которые использует эта ячейка.

Это свойство автоматически копируется при использовании CellTrait

[]

$pluginsource

public строка

Автоматически устанавливается в имя плагина.

$requestsource

public Cake\Http\ServerRequest

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

$responsesource

public Cake\Http\Response

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

$templatesource

public строка

Имя шаблона, который будет отрисован. Это свойство склоняется из имени действия, которое было вызвано.

© 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.6/class-Cake.View.Cell.html

Spec-Zone.ru

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