Класс Cell
Базовый класс Cell.
- Cake\View\Cell использует Cake\Event\EventDispatcherTrait , Cake\ORM\Locator\LocatorAwareTrait , Cake\Datasource\ModelAwareTrait , Cake\View\ViewVarsTrait
Краткое описание свойств
-
$ViewpublicЭкземпляр объекта View, созданный во время рендеринга. Не будет задан до вызова Cell::__toString().
-
$_cacheprotectedНастройка кэширования.array|boolean -
$_validCellOptionsprotectedarrayСписок допустимых параметров (четвертый аргумент конструктора). Переопределите это свойство в подклассах, чтобы разрешить только те параметры, которые вы хотите установить в качестве свойств вашего Cell.
-
$_validViewOptionsprotectedЭти свойства могут быть установлены непосредственно в Cell и переданы в View в качестве параметров.array -
$actionpublicДействие ячейки для вызова.string -
$argspublicАргументы для передачи методу ячейки.array -
$helperspublicПодключаемые модули, используемые этой ячейкой.array -
$pluginpublicАвтоматически устанавливается в имя плагина.string -
$requestpublicЭкземпляр объекта Cake\Http\ServerRequest, содержащего информацию о текущем запросе. Этот объект содержит всю информацию о запросе и несколько методов для получения дополнительной информации о запросе.
- Экземпляр объекта Response, содержащего информацию о предстоящем ответе.
$responsepublic -
$templatepublicstringИмя шаблона, который будет отрисован. Это свойство образуется из имени метода, вызвавшего действие.
Наследованные магические свойства
Наследованные свойства
-
_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необязательный [] - Параметры ячейки для применения.
__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\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 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\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–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