Класс Cell
Базовый класс ячейки.
- Cake\View\Cell использует Cake\Event\EventDispatcherTrait, Cake\ORM\Locator\LocatorAwareTrait, Cake\Datasource\ModelAwareTrait, Cake\View\ViewVarsTrait
Подробное описание методов
__constructsource 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необязательный [] - Параметры ячейки для применения.
__toStringsource public
__toString( )
Магический метод.
Запускает процесс отрисовки, когда ячейка выводится на экран.
Примечание Этот метод вызовет ошибку, когда произойдёт проблема с отрисовкой представления. Это связано с тем, что PHP не позволит методу __toString() генерировать исключения.
Возвращает
stringОтображённая ячейка
_cacheConfigsource protected
_cacheConfig( string $template )
Генерирует ключ кэша для этой ячейки.
Если ключ не определён, будут использоваться класс ячейки и шаблон.
Параметры
- строка
$template - Отображаемый шаблон.
Возвращает
arrayНастройки кэширования.
rendersource public
render( string|null $template null )
Отрисовать ячейку.
Параметры
- строка|null
$templateнеобязательный null - Наименование пользовательского шаблона для отрисовки. Если не указано (null), используется последнее значение. Это значение автоматически устанавливается
CellTrait::cell().
Возвращает
stringОтображённая ячейка.
Исключения
Cake\View\Exception\MissingCellViewExceptionПри возникновении MissingTemplateException во время отрисовки.
Методы, используемые из Cake\Event\EventDispatcherTrait
dispatchEventsource public
dispatchEvent( string $name , array|null $data null , object|null $subject null )
Обёртка для создания и отправки событий.
Возвращает отправленное событие.
Параметры
- строка
$name - Имя события.
- массив|null
$dataнеобязательный null - Любое значение, которое вы хотите передать с этим событием, чтобы его могли прочитать слушатели.
- объект|null
$subjectнеобязательный null - Объект, к которому относится это событие ($this по умолчанию).
Возвращает
Cake\Event\Event\Cake\Event\Event
eventManagersource public
eventManager( Cake\Event\EventManager $eventManager null )
Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.
Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов к событиям объекта, или создавать собственные события и запускать их по своему усмотрению.
Параметры
-
Cake\Event\EventManager$eventManagerнеобязательный null - eventManager для установки
Возвращает
Cake\Event\EventManager\Cake\Event\EventManager
Методы, используемые из Cake\ORM\Locator\LocatorAwareTrait
tableLocatorsource public
tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator null )
Устанавливает локатор таблицы. Если параметры не переданы, возвращает текущий используемый локатор.
Параметры
-
Cake\ORM\Locator\LocatorInterface$tableLocatorнеобязательный null - Экземпляр LocatorInterface.
Возвращает
Cake\ORM\Locator\LocatorInterface\Cake\ORM\Locator\LocatorInterface
Методы, используемые из Cake\Datasource\ModelAwareTrait
_setModelClasssource protected
_setModelClass( string $name )
Устанавливает свойства modelClass и modelKey на основе соглашений.
Если свойства уже установлены, они не будут перезаписаны
Параметры
- строка
$name - Имя класса.
loadModelsource public
loadModel( string|null $modelClass null , string|null $modelType null )
Загружает и создаёт объекты репозитория, необходимые для этого объекта.
Обычно используется для загрузки объектов ORM Table, если они требуются. Также может использоваться для загрузки других типов объектов репозитория, которые использует ваше приложение.
Если поставщик репозитория не возвращает объект, будет выброшено исключение MissingModelException.
Параметры
- строка|null
$modelClassнеобязательный null - Имя класса модели для загрузки. По умолчанию $this->modelClass
- строка|null
$modelTypeнеобязательный null - Тип репозитория для загрузки. По умолчанию значение modelType().
Возвращает
objectЭкземпляр созданной модели.
Исключения
Cake\Datasource\Exception\MissingModelExceptionЕсли класс модели не найден.
InvalidArgumentExceptionПри использовании типа, который не был зарегистрирован.
UnexpectedValueExceptionЕсли тип модели не определён
modelFactorysource public
modelFactory( string $type , callable $factory )
Регистрирует вызов для генерации репозиториев заданного типа.
Параметры
- строка
$type - Имя типа репозитория, для которого предназначена функция-фабрика.
- вызов
$factory - Функция-фабрика, используемая для создания экземпляров.
modelTypesource public
modelType( string|null $modelType null )
Установить или получить тип модели, который будет использоваться этим классом.
Параметры
- строка|null
$modelTypeнеобязательный null - Тип модели или null для получения текущего
Возвращает
string|$this$this
Методы, используемые из Cake\View\ViewVarsTrait
createViewsource public
createView( string|null $viewClass null )
Создаёт экземпляр класса представления на основе текущей конфигурации.
Параметры
- строка|null
$viewClassнеобязательный null - Необязательное полное имя класса представления для создания экземпляра.
Возвращает
Cake\View\View\Cake\View\View
Исключения
Cake\View\Exception\MissingViewExceptionЕсли класс представления не был найден.
setsource public
set( string|array $name , string|array|null|boolean $value null )
Сохраняет переменную или ассоциативный массив переменных для использования внутри шаблона.
Параметры
- string|array
$name - Строка или массив данных.
- string|array|null|boolean
$valueнеобязательный null - Значение в случае, если $name является строкой (которая затем работает как ключ). Не используется, если $name является ассоциативным массивом, в противном случае служит значениями для ключей $name.
Возвращаемое значение
mixed$this
viewBuildersource public
viewBuilder( )
Получить используемый конструктор представления.
Возвращаемое значение
Cake\View\ViewBuilder\Cake\View\ViewBuilder
viewOptionssource public
viewOptions( string|array|null $options null , boolean $merge true )
Получить/установить допустимые параметры представления в свойстве объекта _validViewOptions. Свойство создается как пустой массив, если оно не задано. Если вызывается без параметров, он вернёт текущий список допустимых параметров представления. Смотрите createView().
Параметры
- string|array|null
$optionsнеобязательный null - Строка или массив строк, которые будут добавлены к _validViewOptions.
- boolean
$mergeнеобязательный true - Следует ли объединить или перезаписать существующие допустимые параметры представления. По умолчанию
true.
Возвращаемое значение
arrayОбновлённые параметры представления в виде массива.
Краткое описание свойств
Свойства, используемые из Cake\Event\EventDispatcherTrait
$_eventClasssource
protected string
Имя класса по умолчанию для новых объектов событий.
'\Cake\Event\Event' $_eventManagersource
protected Cake\Event\EventManager
Экземпляр Cake\Event\EventManager, используемый этим объектом для отправки внутренних событий.
null Свойства, используемые из Cake\ORM\Locator\LocatorAwareTrait
Свойства, используемые из Cake\Datasource\ModelAwareTrait
$modelClasssource
public string
Основное имя класса модели этого объекта. Должно быть в множественном числе. CakePHP не будет склонять имя.
Пример: для объекта с именем 'Комментарии', моделью будет 'Комментарии'. Классы плагинов должны использовать имена типа Plugin.Comments для правильной загрузки моделей из соответствующего плагина.
Свойства, используемые из Cake\View\ViewVarsTrait
$_viewBuildersource
protected Cake\View\ViewBuilder
Экземпляр конструктора представления, используемый в данный момент.
$viewClasssource
public string
Имя класса представления по умолчанию.
Устаревшее
3.1.0 Используйте$this->viewBuilder()->className() вместо этого.null
© 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.1/class-Cake.View.Cell.html