Spec-Zone.ru › CakePHP 4.2

Класс Cell

Базовый класс ячейки.

Абстрактный
Пространство имен: Cake\View

Константы

  • string
    TEMPLATE_FOLDER 
    'cell'

    Константа для имени папки, содержащей шаблоны ячейки.

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

  • $View protected
    Cake\View\View

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

  • $_cache protected
    array|bool

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

  • $_eventClass protected
    string

    Имя по умолчанию класса для новых объектов событий.

  • $_eventManager protected
    Cake\Event\EventManagerInterface|null

    Экземпляр Cake\Event\EventManager, используемый этим объектом для отправки внутренних событий.

  • $_modelFactories protected
    (callableCake\Datasource\Locator\LocatorInterface)[]

    Список переопределённых функций фабрики моделей.

  • $_modelType protected
    string

    Тип модели для использования.

  • $_tableLocator protected
    Cake\ORM\Locator\LocatorInterface|null

    Экземпляр локатора таблиц.

  • $_validCellOptions protected
    array

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

  • $_viewBuilder protected
    Cake\View\ViewBuilder|null

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

  • $action protected
    string

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

  • $args protected
    array

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

  • $modelClass protected
    string|null

    Основное имя класса модели этого объекта. Должен быть множественным числом. CakePHP не будет склонять имя.

  • $request protected
    Cake\Http\ServerRequest

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

  • $response protected
    Cake\Http\Response

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

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

  • __construct() public

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

  • __debugInfo() public

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

  • __toString() public

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

  • _cacheConfig() protected

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

  • _setModelClass() protected

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

  • createView() public

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

  • dispatchEvent() public

    Обёртка для создания и отправки событий.

  • getEventManager() public

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

  • getModelType() public

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

  • getTableLocator() public

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

  • initialize() public

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

  • loadModel() public

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

  • modelFactory() public

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

  • render() public

    Отобразить ячейку.

  • set() public

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

  • setEventManager() public

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

  • setModelType() public

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

  • setTableLocator() public

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

  • viewBuilder() public

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

END_OF_DOCUMENT_MARKER ```

Метод детали

__construct() public 

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

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

Параметры

Cake\Http\ServerRequest $request

Запрос, используемый в ячейке.

Cake\Http\Response $response

Ответ, используемый в ячейке.

Cake\Event\EventManagerInterface $eventManager optional

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

array $cellOptions optional

Параметры ячейки для применения.

__debugInfo() public 

__debugInfo(): array

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

Возвращает

array

__toString() public 

__toString(): string

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

Запускает процесс отрисовки, когда ячейка выводится.

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

Возвращает

string

Вызывает

Error
Включает детали ошибок для фатальных ошибок PHP 7.

_cacheConfig() protected 

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

Генерирует ключ кэша для использования этой ячейки.

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

Параметры

string $action

Вызванное действие.

string|null $template optional

Имя шаблона, который нужно отобразить.

Возвращает

array

_setModelClass() protected 

_setModelClass(string $name): void

Устанавливает свойство modelClass на основе конвенций.

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

Параметры

string $name

Имя класса.

Возвращает

void

createView() public 

createView(string|null $viewClass = null): Cake\View\View

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

Параметры

string|null $viewClass optional

Необязательное именованное пространство имён имя класса View для создания экземпляра.

Возвращает

Cake\View\View

Вызывает

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

dispatchEvent() public 

dispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventInterface

Обёртка для создания и отправки событий.

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

Параметры

string $name

Имя события.

array|null $data optional

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

object|null $subject optional

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

Возвращает

Cake\Event\EventInterface

getEventManager() public 

getEventManager(): Cake\Event\EventManagerInterface

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

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

Возвращает

Cake\Event\EventManagerInterface

getModelType() public 

getModelType(): string

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

Возвращает

string

getTableLocator() public 

getTableLocator(): Cake\ORM\Locator\LocatorInterface

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

Возвращает

Cake\ORM\Locator\LocatorInterface

initialize() public 

initialize(): void

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

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

Возвращает

void

loadModel() public 

loadModel(string|null $modelClass = null, string|null $modelType = null): Cake\Datasource\RepositoryInterface

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

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

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

Параметры

string|null $modelClass optional

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

string|null $modelType optional

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

Возвращает

Cake\Datasource\RepositoryInterface

Вызывает

Cake\Datasource\Exception\MissingModelException
Если класс модели не найден.
UnexpectedValueException
Если аргумент $modelClass не предоставлен, а свойство ModelAwareTrait::$modelClass пустое.

modelFactory() public 

modelFactory(string $type, callableCake\Datasource\Locator\LocatorInterface $factory): void

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

Параметры

string $type

Имя типа репозитория, для которого предназначена функция-фабрика.

callableCake\Datasource\Locator\LocatorInterface $factory

Функция-фабрика, используемая для создания экземпляров.

Возвращает

void

render() public 

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

Отобразить ячейку.

Параметры

string|null $template optional

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

Возвращает

string

Вызывает

Cake\View\Exception\MissingCellTemplateException

set() public 

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

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

Параметры

string|array $name

Строка или массив данных.

mixed $value optional

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

Возвращает

$this

setEventManager() public 

setEventManager(Cake\Event\EventManagerInterface $eventManager): $this

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

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

Параметры

Cake\Event\EventManagerInterface $eventManager

устанавливаемое управление событиями

Возвращает

$this

setModelType() public 

setModelType(string $modelType): $this

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

Параметры

string $modelType

Тип модели

Возвращает

$this

setTableLocator() public 

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

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

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator

Экземпляр LocatorInterface.

Возвращает

$this

viewBuilder() public 

viewBuilder(): Cake\View\ViewBuilder

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

Возвращает

Cake\View\ViewBuilder

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

$View protected

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

Тип

Cake\View\View

$_cache protected

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

Тип

array|bool

$_eventClass protected

Имя класса по умолчанию для новых объектов событий.

Тип

string

$_eventManager protected

Экземпляр Cake\Event\EventManager, используемый этим объектом для отправки внутренних событий.

Тип

Cake\Event\EventManagerInterface|null

$_modelFactories protected

Список переопределённых функций фабрики моделей.

Тип

(callableCake\Datasource\Locator\LocatorInterface)[]

$_modelType protected

Тип модели для использования.

Тип

string

$_tableLocator protected

Экземпляр локатора таблиц

Тип

Cake\ORM\Locator\LocatorInterface|null

$_validCellOptions protected

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

Тип

array

$_viewBuilder protected

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

Тип

Cake\View\ViewBuilder|null

$action protected

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

Тип

string

$args protected

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

Тип

array

$modelClass protected

Основное имя класса модели этого объекта. Должно быть в множественном числе. CakePHP не будет склонять имя.

Пример: Для объекта под названием 'Комментарии', modelClass будет 'Комментарии'. Классы плагинов должны использовать имена в формате Plugin.Comments для правильной загрузки моделей из соответствующего плагина.

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

Тип

string|null

$request protected

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

Тип

Cake\Http\ServerRequest

$response protected

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

Тип

Cake\Http\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/4.2/class-Cake.View.Cell.html

Spec-Zone.ru

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