Spec-Zone.ru › CakePHP 4.3

Класс Cell

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

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

Константы

  • string
    TEMPLATE_FOLDER 
    'cell'

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

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

  • $View protected
    Cake\View\View

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

  • $_cache protected
    array|bool

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

  • $_eventClass protected
    string

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

  • $_eventManager protected
    Cake\Event\EventManagerInterface|null

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

  • $_modelFactories protected
    array<callableCake\Datasource\Locator\LocatorInterface>

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

  • $_modelType protected
    string

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

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

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

  • $_validCellOptions protected
    array<string>

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

  • $_viewBuilder protected
    Cake\View\ViewBuilder|null

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

  • $action protected
    string

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

  • $args protected
    array

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

  • $defaultTable protected
    string|null

    Псевдоним таблицы по умолчанию для этого объекта.

  • $modelClass protected deprecated
    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

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

  • fetchTable() public

    Удобный метод для получения экземпляра таблицы.

  • getEventManager() public

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

  • getModelType() public

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

  • getTableLocator() public

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

  • initialize() public

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

  • loadModel() public deprecated

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

  • 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|null $eventManager = null, array<string, mixed> $cellOptions = [])

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

Параметры

Cake\Http\ServerRequest $request

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

Cake\Http\Response $response

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

Cake\Event\EventManagerInterface|null $eventManager необязательно

Объект eventManager для привязки событий.

array<string, mixed> $cellOptions необязательно

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

__debugInfo() public 

__debugInfo(): array<string, mixed>

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

Возвращает

array<string, mixed>

__toString() public 

__toString(): string

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

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

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

Возвращает

string

Исключения

Error
Включает подробности об ошибках PHP 7.

_cacheConfig() protected 

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

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

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

Параметры

string $action

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

string|null $template необязательно

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

Возвращает

array

_setModelClass() protected 

_setModelClass(string $name): void

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

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

Параметры

string $name

Имя класса.

Возвращает

void

createView() public 

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

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

Параметры

string|null $viewClass необязательно

Необязательное имя пространства имён класса 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 необязательно

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

object|null $subject необязательно

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

Возвращает

Cake\Event\EventInterface

fetchTable() public 

fetchTable(string|null $alias = null, array<string, mixed> $options = []): Cake\ORM\Table

Удобный метод для получения экземпляра таблицы.

Параметры

string|null $alias необязательно

Имя псевдонима, которое вы хотите получить. Должно быть в формате CamelCase. Если null, используется значение свойства $defaultTable.

array<string, mixed> $options необязательно

Параметры, с которыми вы хотите создать таблицу. Если таблица уже загружена, параметры реестра будут проигнорированы.

Возвращает

Cake\ORM\Table

Исключения

Cake\Core\Exception\CakeException
Если аргумент `$alias` и свойство `$defaultTable` оба равны `null`.

См. также

\Cake\ORM\TableLocator::get()

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 необязательно

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

string|null $modelType необязательно

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

Возвращает

Cake\Datasource\RepositoryInterface

Исключения

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

modelFactory() public 

modelFactory(string $type, Cake\Datasource\Locator\LocatorInterface|callable $factory): void

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

Параметры

string $type

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

Cake\Datasource\Locator\LocatorInterface|callable $factory

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

Возвращает

void

render() public 

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

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

Параметры

string|null $template необязательно

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

Возвращает

string

Исключения

Cake\View\Exception\MissingCellTemplateException

BadMethodCallException

set() public 

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

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

Параметры

array|string $name

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

mixed $value необязательно

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

Возвращает

$this

setEventManager() public 

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

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

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

Параметры

Cake\Event\EventManagerInterface $eventManager

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

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

Тип

array<callableCake\Datasource\Locator\LocatorInterface>

$_modelType protected

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

Тип

string

$_tableLocator protected

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

Тип

Cake\ORM\Locator\LocatorInterface|null

$_validCellOptions protected

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

Тип

array<string>

$_viewBuilder protected

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

Тип

Cake\View\ViewBuilder|null

$action protected

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

Тип

string

$args protected

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

Тип

array

$defaultTable protected

Псевдоним таблицы по умолчанию для этого объекта.

Тип

string|null

$modelClass protected deprecated

Полное имя основного класса модели для этого объекта. Должно быть в множественном числе. 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.3/class-Cake.View.Cell.html

Spec-Zone.ru

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