Класс 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Действие Cell для вызова.string -
$argspublicАргументы для передачи методу Cell.array -
$helperspublicПодключаемые модули, используемые данным Cell.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Генерировать ключ кеша для этого элемента.
- 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 - Необязательное имя класса представления с пространством имен для создания экземпляра.
Возвращает
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.
- булево
$mergeнеобязательно true Объединять или перезаписывать существующие допустимые параметры представления. По умолчанию
true.
Возвращает
массивОбновлённые параметры представления в виде массива.
Подробное описание свойств
$Viewsource
public Cake\View\View
Экземпляр представления, созданный во время рендеринга. Не будет установлен до тех пор, пока не будет вызван Cell::__toString().
Устарело
3.1.0 Используйте createView() вместо этого.$_validCellOptionssource
protected массив
Список допустимых параметров (четвертый аргумент конструктора) Переопределите это свойство в подклассах, чтобы разрешить только те параметры, которые вы хотите установить в качестве свойств в вашем Cell.
[]
$_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–2017 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.4/class-Cake.View.Cell.html