Класс 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\Network\Request, содержащего информацию о текущем запросе. Этот объект содержит всю информацию о запросе и несколько методов для чтения дополнительной информации о запросе.
- Экземпляр объекта Response, содержащего информацию о предстоящем ответе.
$responsepublic -
$templatepublicstringИмя шаблона, который будет рендериться. Это свойство инфлексируется из имени действия, которое было вызвано.
Унаследованные свойства
-
_eventClass,_eventManager_tableLocator_modelFactories,_modelType,modelClass_viewBuilder,viewClass,viewVars
Краткое описание методов
- __construct() publicКонструктор.
- __debugInfo() publicИнформация для отладки.
- __toString() publicМагический метод.
- _cacheConfig() protectedГенерирует ключ кэша для этого Cell.
- render() publicРендеринг Cell.
Подробное описание методов
__construct()source public
__construct( Cake\Network\Request $request null , Cake\Network\Response $response null , Cake\Event\EventManager $eventManager null , array $cellOptions [] )
Конструктор.
Параметры
-
Cake\Network\Request$requestнеобязательный null - Запрос, который нужно использовать в Cell.
-
Cake\Network\Response$responseнеобязательный null - Ответ, который нужно использовать в Cell.
-
Cake\Event\EventManager$eventManagerнеобязательный null - EventManager для привязки событий.
- массив
$cellOptionsнеобязательный [] - Опции Cell для применения.
__toString()source public
__toString( )
Магический метод.
Запускает процесс рендеринга, когда Cell выводится на экран.
Примечание Этот метод вызовет ошибку, если у рендеринга View возникнут проблемы. Это происходит потому, что PHP не позволит методу __toString() генерировать исключение.
Возвращает
строкаРендеренный Cell
Вызывает
ОшибкаПодробности об ошибке для фатальных ошибок PHP 7.
_cacheConfig()source protected
_cacheConfig( string $action )
Генерирует ключ кэша для этого Cell.
Если ключ не определён, будет использовано имя класса Cell и имя действия.
Параметры
- строка
$action - Вызванное действие.
Возвращает
массивНастройка кэширования.
render()source public
render( string|null $template null )
Рендеринг Cell.
Параметры
- строка|null
$templateнеобязательный null Пользовательское имя шаблона для рендеринга. Если не указано (null), будет использовано последнее значение. Это значение автоматически устанавливается
CellTrait::cell().
Возвращает
строкаРендеренный 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 для этого объекта.
Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов к событиям объекта, или создавать свои собственные события и вызывать их по желанию.
Параметры
-
Cake\Event\EventManager$eventManagerнеобязательный null - eventManager для установки
Возвращает
Cake\Event\EventManagerИспользуемые методы из Cake\ORM\Locator\LocatorAwareTrait
tableLocator()source public
tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator null )
Устанавливает локатор таблиц. Если не переданы параметры, он вернёт текущий используемый локатор.
Параметры
-
Cake\ORM\Locator\LocatorInterface$tableLocatorнеобязательный null - Экземпляр LocatorInterface.
Возвращает
Cake\ORM\Locator\LocatorInterfaceИспользуемые методы из Cake\Datasource\ModelAwareTrait
_setModelClass()source protected
_setModelClass( string $name )
Устанавливает свойства modelClass и modelKey на основе соглашений.
Если свойства уже установлены, они не будут перезаписаны.
Параметры
- строка
$name - Имя класса.
loadModel()source public
loadModel( string|null $modelClass null , string|null $modelType null )
Загружает и создает объекты репозитория, необходимые для этого объекта.
Обычно используется для загрузки объектов ORM Table по мере необходимости. Также может использоваться для загрузки других типов объектов репозитория, используемых вашим приложением.
Если поставщик репозитория не возвращает объект, будет выброшено исключение MissingModelException.
Parameters
- string|null
$modelClassoptional null - Имя класса модели для загрузки. По умолчанию равно $this->modelClass
- string|null
$modelTypeoptional null - Тип репозитория для загрузки. По умолчанию равно значению modelType().
Returns
Cake\Datasource\RepositoryInterfaceСозданный экземпляр модели.
Throws
Cake\Datasource\Exception\MissingModelExceptionЕсли класс модели не найден.
InvalidArgumentException
При использовании типа, который не был зарегистрирован.
UnexpectedValueException
Если тип модели не определен
modelFactory()source public
modelFactory( string $type , callable $factory )
Регистрирует вызов для генерации репозиториев заданного типа.
Parameters
- string
$type - Имя типа репозитория, для которого предназначена функция фабрики.
- callable
$factory - Функция фабрики, используемая для создания экземпляров.
modelType()source public
modelType( string|null $modelType null )
Устанавливает или получает тип модели, используемый этим классом
Parameters
- string|null
$modelTypeoptional null - Тип модели или null для получения текущего
Returns
string|Cake\Datasource\ModelAwareTrait$this
Методы, используемые из Cake\View\ViewVarsTrait
createView()source public
createView( string|null $viewClass null )
Создает экземпляр класса представления на основе текущей конфигурации.
Parameters
- string|null
$viewClassoptional null - Необязательное имя пространства имен класса View для создания экземпляра.
Returns
Cake\View\ViewThrows
Cake\View\Exception\MissingViewExceptionЕсли класс представления не был найден.
set()source public
set( string|array $name , string|array|null|boolean $value null )
Сохраняет переменную или ассоциативный массив переменных для использования внутри шаблона.
Parameters
- string|array
$name - Строка или массив данных.
- string|array|null|boolean
$valueoptional null Значение в случае, если $name является строкой (которая затем работает как ключ). Не используется, если $name является ассоциативным массивом, в противном случае служит в качестве значений для ключей $name.
Returns
$this
viewBuilder()source public
viewBuilder( )
Получить используемый билдер представления.
Returns
Cake\View\ViewBuilderviewOptions()source public
viewOptions( string|array|null $options null , boolean $merge true )
Получить/Установить допустимые параметры представления в свойстве _validViewOptions объекта. Свойство создается как пустой массив, если оно не задано. Если вызывается без параметров, будет возвращен текущий список допустимых параметров представления. См. createView().
Parameters
- string|array|null
$optionsoptional null - строка или массив строк, которые будут добавлены к _validViewOptions.
- boolean
$mergeoptional true Объединить или переопределить существующие допустимые параметры представления. По умолчанию
true.
Returns
arrayОбновленные параметры представления в виде массива.
Подробное описание свойств
$Viewsource
public Cake\View\View
Экземпляр представления, созданный во время рендеринга. Не будет установлен до вызова Cell::__toString().
Устарело
3.1.0 Используйте createView() вместо этого.$_validCellOptionssource
protected array
Список допустимых параметров (четвертый аргумент конструктора) Переопределите это свойство в подклассах, чтобы разрешить только те параметры, которые вы хотите установить как свойства в вашем Cell.
[]
$_validViewOptionssource
protected array
Эти свойства могут быть установлены непосредственно в Cell и переданы в View в качестве параметров.
См.
Cake\View\View[
'viewPath'
] $helperssource
public array
Подключаемые модули, используемые этой ячейкой.
Это свойство автоматически копируется при использовании CellTrait
[]
$requestsource
public Cake\Network\Request
Экземпляр объекта Cake\Network\Request, содержащий информацию о текущем запросе. Этот объект содержит всю информацию о запросе и несколько методов для чтения дополнительной информации о запросе.
$responsesource
public Cake\Network\Response
Экземпляр объекта Response, содержащий информацию о предстоящем ответе
$templatesource
public string
Имя шаблона, который будет рендериться. Это свойство инфлируется из имени действия, которое было вызвано.
© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.View.Cell.html