Класс Cell
Базовый класс ячейки.
- Cake\View\Cell использует Cake\Event\EventDispatcherTrait , Cake\ORM\Locator\LocatorAwareTrait , Cake\Datasource\ModelAwareTrait , Cake\View\ViewVarsTrait
Краткое описание свойств
-
$ViewpublicЭкземпляр представления, созданный во время отрисовки. Не будет установлен до вызова Cell::__toString().
-
$_cacheprotectedНастройка кэширования.array|boolean -
$_validCellOptionsprotectedarrayСписок допустимых опций (четвертый аргумент конструктора). Переопределите это свойство в подклассах, чтобы указать, какие опции вы хотите установить как свойства в вашей ячейке.
-
$_validViewOptionsprotectedЭти свойства можно установить непосредственно в ячейке и передать представлению в качестве опций.array -
$actionpublicДействие ячейки для вызова.string -
$argspublicАргументы для передачи в действие ячейки.array -
$helperspublicПлагины, используемые этой ячейкой.array -
$pluginpublicАвтоматически устанавливается в имя плагина.string -
$requestpublicЭкземпляр объекта Cake\Http\ServerRequest, содержащий информацию об текущем запросе. Этот объект содержит всю информацию о запросе и несколько методов для чтения дополнительной информации о запросе.
- Экземпляр объекта ответа, содержащий информацию о предстоящем ответе.
$responsepublic -
$templatepublicstringИмя шаблона, который будет отрисован. Это свойство инфлектируется из имени действия, которое было вызвано.
Унаследованные магические свойства
Унаследованные свойства
-
_eventClass,_eventManager_tableLocator_modelFactories,_modelType,modelClass_viewBuilder,viewClass,viewVars
Краткое описание методов
- __construct() publicКонструктор.
- __debugInfo() publicИнформация для отладки.
- __toString() publicМагический метод.
- _cacheConfig() protectedГенерирует ключ кэша для этой ячейки.
- 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необязательно [] - Опции ячейки для применения.
__toString()source public
__toString( )
Магический метод.
Запускает процесс отрисовки, когда ячейка выводится.
Примечание Этот метод вызовет ошибку, когда возникает проблема с отрисовкой представления. Это связано с тем, что PHP не позволит методу __toString() бросать исключение.
Возвращает
строкаОтображенная ячейка
Выбрасывает
ОшибкаПодробности ошибки для фатальных ошибок PHP 7.
_cacheConfig()source protected
_cacheConfig( string $action , string|null $template null )
Генерирует ключ кэша для этой ячейки.
Если ключ не определен, будет использоваться имя класса ячейки и имя действия.
Параметры
- строка
$action - Вызванное действие.
- строка|null
$templateнеобязательно null - Имя шаблона, который будет отрисован.
Возвращает
массивНастройка кэша.
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\EventeventManager()source public
eventManager( Cake\Event\EventManager $eventManager null )
Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.
Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов к событиям объекта, или создавать собственные события и вызывать их по желанию.
Устарело
3.5.0 Используйте getEventManager()/setEventManager() вместо этого.Параметры
-
Cake\Event\EventManager$eventManagerнеобязательно null - eventManager для установки
Возвращает
Cake\Event\EventManagergetEventManager()source public
getEventManager( )
Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.
Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов к событиям объекта, или создавать собственные события и вызывать их по желанию.
Возвращает
Cake\Event\EventManagersetEventManager()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\LocatorInterfacesetTableLocator()source public
setTableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator )
Устанавливает локатор таблиц.
Параметры
-
Cake\ORM\Locator\LocatorInterface$tableLocator - Экземпляр LocatorInterface.
Возвращает
$this
tableLocator()source public
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
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 - Необязательное имя класса View с пространством имён для создания экземпляра.
Возвращает
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\ViewBuilderviewOptions()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() вместо этого.$_validCellOptionssource
protected массив
Список допустимых параметров (четвёртый аргумент конструктора). Переопределите это свойство в подклассах, чтобы разрешить только те параметры, которые вы хотите установить в качестве свойств вашей ячейки.
[]
$_validViewOptionssource
protected массив
Эти свойства могут быть заданы непосредственно в ячейке и переданы в Вид в качестве параметров.
См.
Cake\View\View[
'viewPath'
] $helperssource
public массив
Плагины, используемые этой ячейкой.
Это свойство копируется автоматически при использовании CellTrait.
[]
$requestsource
public Cake\Http\ServerRequest
Экземпляр объекта Cake\Http\ServerRequest, содержащий информацию о текущем запросе. Этот объект содержит всю информацию о запросе и несколько методов для чтения дополнительной информации о запросе.
$responsesource
public Cake\Http\Response
Экземпляр объекта Response, содержащий информацию о предстоящем ответе
$templatesource
public строка
Имя шаблона, который будет отображен. Это свойство изменяется из имени действия, которое было вызвано.
© 2005–2018 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.5/class-Cake.View.Cell.html