Класс 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Список допустимых параметров (четвёртый аргумент конструктора). Переопределите это свойство в подклассах, чтобы указать, какие параметры вы хотите установить как свойства в своей ячейке.
-
$_validViewOptionsprotectedЭти свойства могут быть установлены непосредственно в ячейке и переданы в View в качестве параметров.array -
$actionpublicДействие ячейки для вызова.string -
$argspublicАргументы для передачи методу ячейки.array -
$helperspublicПлагины, используемые этой ячейкой.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Генерация ключа кэша для этой ячейки.
- render() publicОтрисовка ячейки.
Подробное описание методов
__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 - Запрос, используемый в ячейке.
-
Cake\Network\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 для этого объекта.
Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов к событиям объекта, или создавать свои собственные события и запускать их по своему желанию.
Параметры
-
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 по мере необходимости. Также может использоваться для загрузки других типов объектов репозитория, используемых вашим приложением.
Если поставщик репозитория не возвращает объект, будет выброшено исключение MissingModelException.
Параметры
- string|null
$modelClassнеобязательно null - Имя класса модели для загрузки. По умолчанию $this->modelClass
- string|null
$modelTypeнеобязательно null - Тип репозитория для загрузки. По умолчанию значение modelType().
Возвращает
Cake\Datasource\RepositoryInterfaceСозданный экземпляр модели.
Исключения
Cake\Datasource\Exception\MissingModelExceptionЕсли класс модели не найден.
InvalidArgumentException
При использовании типа, который не был зарегистрирован.
UnexpectedValueException
Если тип модели не определён
modelFactory()source public
modelFactory( string $type , callable $factory )
Переопределить существующую функцию для генерации репозиториев заданного типа.
Параметры
- string
$type - Имя типа репозитория, для которого предназначена функция фабрики.
- callable
$factory - Функция фабрики, используемая для создания экземпляров.
modelType()source public
modelType( string|null $modelType null )
Установить или получить тип модели, который будет использоваться этим классом
Параметры
- string|null
$modelTypeнеобязательно null - Тип модели или null для получения текущего
Возвращает
string|Cake\Datasource\ModelAwareTrait$this
Методы, используемые из Cake\View\ViewVarsTrait
createView()source public
createView( string|null $viewClass null )
Создает экземпляр класса представления на основе текущей конфигурации.
Параметры
- string|null
$viewClassнеобязательно null - Необязательное полное имя класса представления для создания экземпляра.
Возвращает
Cake\View\ViewИсключения
Cake\View\Exception\MissingViewExceptionЕсли класс представления не был найден.
set()source public
set( string|array $name , mixed $value null )
Сохраняет переменную или ассоциативный массив переменных для использования внутри шаблона.
Параметры
- string|array
$name - Строка или массив данных.
- mixed
$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().
Параметры
- string|array|null
$optionsнеобязательно null - строка или массив строк, которые будут добавлены в _validViewOptions.
- boolean
$mergeнеобязательно true Объединить или перезаписать существующие допустимые параметры представления. По умолчанию
true.
Возвращает
arrayОбновленные опции представления в виде массива.
Подробное описание свойств
$Viewsource
public Cake\View\View
Экземпляр представления, созданный во время рендеринга. Не будет задан до тех пор, пока не будет вызван Cell::__toString().
Устарело
3.1.0 Используйте createView() вместо этого.$_validCellOptionssource
protected array
Список допустимых опций (четвертый аргумент конструктора) Переопределите это свойство в подклассах, чтобы разрешить установку тех опций, которые вы хотите установить в качестве свойств в вашей ячейке.
[]
$_validViewOptionssource
protected array
Эти свойства могут быть установлены непосредственно в ячейке и переданы в представление в качестве опций.
См. также
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–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.3/class-Cake.View.Cell.html