Класс SerializedView

__construct()source public

__construct( Cake\Network\Request $request null , Cake\Network\Response $response null , Cake\Event\EventManager $eventManager null , array $viewOptions [] )

Конструктор

Параметры

Cake\Network\Request $request необязательно null

Экземпляр запроса.

Cake\Network\Response $response необязательно null

Экземпляр ответа.

Cake\Event\EventManager $eventManager необязательно null

Экземпляр EventManager.

массив $viewOptions необязательно []

Массив параметров представления

Переопределяет

Cake\View\View::__construct()

loadHelpers()source public

loadHelpers( )

Загрузка помощников только при отключенном сериализации.

Переопределяет

Cake\View\View::loadHelpers()

render()source public

render( string|null $view null , string|null $layout null )

Отображение шаблона представления или возврат сериализованных данных.

Особые параметры

_serialize Для преобразования набора переменных представления в сериализованную форму. Его значение может быть строкой для имени одной переменной или массивом для нескольких имен. Если true, все переменные представления будут сериализованы. Если не задано, будет отображен обычный шаблон представления.

Параметры

строка|null $view необязательно null

Отображаемое представление.

строка|null $layout необязательно null

Отображаемый макет.

Возвращает

строка|null
Отображенное представление.

Выбрасывает

Cake\Core\Exception\Exception
Если возникла ошибка в представлении.

Переопределяет

Cake\View\View::render()

__get()source public

__get( string $name )

Магический доступ к помощникам.

Параметры

строка $name

Имя атрибута для получения.

Возвращает

смешанное

__set()source public

__set( string $name , mixed $value )

Магический установщик для устаревших свойств.

Параметры

строка $name

Имя свойства.

смешанное $value

Значение свойства.

_checkFilePath()source protected

_checkFilePath( string $file , string $path )

Проверка, что путь к файлу представления не выходит за пределы определенных путей шаблонов.

Будут проверены только пути, содержащие .., так как они наиболее вероятны для разрешения к файлам за пределами путей шаблонов.

Параметры

строка $file

Путь к файлу шаблона.

строка $path

Базовый путь, внутри которого должен находиться $file.

Возвращает

строка
Путь к файлу

Выбрасывает

InvalidArgumentException

_elementCache()source protected

_elementCache( string $name , array $data , array $options )

Генерация параметров конфигурации кэша для элемента.

Параметры

строка $name

Имя элемента

массив $data

Данные

массив $options

Параметры элемента

Возвращает

массив
Конфигурация кэша элемента.

_evaluate()source protected

_evaluate( string $viewFile , array $dataForView )

Метод песочницы для оценки шаблона/скрипта представления.

Параметры

строка $viewFile

Имя файла представления

массив $dataForView

Данные для включения в рендер представлении. Если пусто, будет использован текущий View::$viewVars.

Возвращает

строка
Результат рендеринга

_getElementFileName()source protected

_getElementFileName( string $name )

Находит имя файла элемента, возвращает false при ошибке.

Параметры

строка $name

Имя элемента для поиска.

Возвращает

строка|false
Строка имени файла элемента или false, если файл не найден.

_getLayoutFileName()source protected

_getLayoutFileName( string|null $name null )

Возвращает имя файла макета для данного шаблона как строку.

Параметры

строка|null $name необязательно null

Имя макета для поиска.

Возвращает

строка
Имя файла макета (.ctp).

Выбрасывает

Cake\View\Exception\MissingLayoutException
при невозможности найти макет

_getSubPaths()source protected

_getSubPaths( string $basePath )

Находит все пути к подшаблонам, основанные на $basePath Если в текущем запросе определен префикс, этот метод добавит префиксный путь к шаблону к $basePath, каскадируя вверх в случае вложенного префикса. По существу, он используется для поиска префиксных путей к шаблонам элементов и макетов.

Параметры

строка $basePath

Базовый путь, для которого получить префиксный.

Возвращает

массив
Массив со всеми путями шаблонов.

_getViewFileName()source protected

_getViewFileName( string|null $name null )

Возвращает имя файла шаблона для данного действия (.ctp) в виде строки. Имена действий с регистром CamelCase по умолчанию будут преобразовываться в нижний регистр с символом подчеркивания. Это означает, что у вас могут быть имена действий LongActionNames, которые относятся к файлам шаблонов long_action_names.ctp. Вы можете изменить правило преобразования, переопределив _inflectViewFileName.

Параметры

string|null $name необязательно null

Действие контроллера, для которого нужно найти имя файла шаблона

Возвращаемое значение

string
Имя файла шаблона

Исключения

Cake\View\Exception\MissingTemplateException
если файл представления не был найден.

_inflectViewFileName()source protected

_inflectViewFileName( string $name )

Изменяет имя файла шаблона представления на нижний регистр с символом подчеркивания.

Параметры

string $name

Имя файла, которое должно быть преобразовано.

Возвращаемое значение

string
Имя файла после преобразования

_paths()source protected

_paths( string|null $plugin null , boolean $cached true )

Возвращает все возможные пути для поиска файлов представлений в определённом порядке.

Параметры

string|null $plugin необязательно null

Необязательное имя плагина, для поиска файлов представлений.

boolean $cached необязательно true

Установите в значение false, чтобы принудительно обновить пути к представлениям. По умолчанию true.

Возвращаемое значение

array
Пути

_render()source protected

_render( string $viewFile , array $data [] )

Отображает и возвращает вывод для заданного имени файла шаблона с его массивом данных. Обрабатывает родительские/расширенные шаблоны.

Параметры

string $viewFile

Имя файла представления

array $data необязательно []

Данные, которые необходимо включить в отображаемое представление. Если пусто, будут использоваться текущие View::$viewVars.

Возвращаемое значение

string
Результат отображения

Исключения

LogicException
Когда блок оставлен открытым.

Вызывает

View.beforeRenderFile $this, [$viewFile]
View.afterRenderFile $this, [$viewFile, $content]

_renderElement()source protected

_renderElement( string $file , array $data , array $options )

Отображает элемент и вызывает перед и после вывода обратные вызовы для него и записывает в кэш, если используется кэш

Параметры

string $file

Путь к файлу элемента

array $data

Данные для отображения

array $options

Параметры элемента

Возвращаемое значение

string

Вызывает

View.beforeRender $this, [$file]
View.afterRender $this, [$file, $element]

append()source public

append( string $name , mixed $value null )

Добавляет к существующему или новому блоку.

Добавление к новому блоку создаст его.

Параметры

string $name

Имя блока

mixed $value необязательно null

Содержание блока. Значение будет приведено к строковому типу.

См. также

\Cake\View\ViewBlock::concat()

assign()source public

assign( string $name , mixed $value )

Устанавливает содержимое для блока. Это перепишет любое существующее содержимое.

Параметры

string $name

Имя блока

mixed $value

Содержание блока. Значение будет приведено к строковому типу.

См. также

\Cake\View\ViewBlock::set()

autoLayout()source public

autoLayout( boolean|null $autoLayout null )

Включает или отключает стандартный режим CakePHP для применения файлов макетов. Включено по умолчанию. Выключение означает, что макеты не будут автоматически применяться к рендеренным шаблонам.

Параметры

boolean|null $autoLayout необязательно null

Булево значение для включения/выключения. Если null, возвращает текущее значение.

Возвращаемое значение

boolean|null

blocks()source public

blocks( )

Получить имена всех существующих блоков.

Возвращаемое значение

array
Массив, содержащий блоки.

См. также

\Cake\View\ViewBlock::keys()

cache()source public

cache( callable $block , array $options [] )

Создать кэшированный блок логики представления.

Это позволяет кэшировать блок вывода представления в кэше, определенном в elementCache.

Этот метод сначала попытается прочитать кэш. Если кэш пуст, $block будет выполнен, а результат будет сохранён.

Параметры

callable $block

Блок кода, для которого требуется кэшировать вывод.

array $options необязательно []

Параметры, определяющие ключ кэша и т.д.

Возвращаемое значение

string
Содержимое результата.

Исключения

RuntimeException
Если $options не содержит параметра 'key'.

element()source public

element( string $name , array $data [] , array $options [] )

Отображает фрагмент PHP с предоставленными параметрами и возвращает HTML, XML или любую другую строку.

Реализует концепцию элементов (или «частичных макетов»), а массив $params используется для отправки данных для использования в элементе. Элементы могут кэшироваться, что повышает производительность, с использованием опции cache.

Параметры

string $name

Имя файла шаблона в папке /src/Template/Element/, или MyPlugin.template для использования шаблона элемента из MyPlugin. Если элемент не найден в плагине, будет выполнен стандартный поиск в пути к представлениям.

array $data необязательно []

Массив данных, которые будут доступны отображаемому представлению (т.е. элементу).

array $options необязательно []

Массив параметров. Возможные ключи: - cache - Может быть true, чтобы включить кэширование, используя конфигурацию в View::$elementCache. Или массив. Если массив, можно использовать следующие ключи: - config - Используется для хранения кэшированного элемента в пользовательской конфигурации кэша. - key - Используется для определения ключа, используемого в Cache::write(). Он будет префиксами element_ - callbacks - Установите в значение true, чтобы вызвать обратные вызовы helper beforeRender и afterRender для этого элемента. По умолчанию false. - ignoreMissing - Используется для разрешения отсутствия элементов. Установите в значение true, чтобы не генерировать исключения.

Возвращаемое значение

string
Отображенный элемент

Исключения

Cake\View\Exception\MissingElementException

Если элемент отсутствует, и ignoreMissing равно false.

elementExists()source public

elementExists( string $name )

Проверяет наличие элемента

Параметры

string $name

Имя файла шаблона в папке /src/Template/Element/, или MyPlugin.template для проверки элемента шаблона из MyPlugin. Если элемент не найден в плагине, будет выполнен стандартный поиск в пути к представлениям.

Возвращаемое значение

boolean
Успех

end()source public

end( )

Завершить блок захвата. Дополнение к View::start()

См. также

\Cake\View\ViewBlock::end()

exists()source public

exists( string $name )

Проверить наличие блока

Параметры

string $name

Имя блока

Возвращаемое значение

boolean

extend()source public

extend( string $name )

Обеспечивает расширение/наследование шаблонов или элементов. Виды могут расширять родительский вид и заполнять блоки в родительском шаблоне.

Параметры

string $name

Шаблон или элемент, с помощью которого следует расширить текущий.

Исключения

LogicException
при расширении шаблона самим собой или создании циклов расширения.
LogicException
при расширении несуществующего элемента

fetch()source public

fetch( string $name , string $default '' )

Извлечь содержимое блока. Если блок пустой или неопределён, будет возвращено ''.

Параметры

string $name

Имя блока

string $default необязательный ''

Текстовый вариант по умолчанию

Возвращает

string
Содержимое блока или $default, если блок не найден.

См. также

\Cake\View\ViewBlock::get()

get()source public

get( string $var , mixed $default null )

Возвращает содержимое заданной переменной представления.

Параметры

string $var

Переменная представления, содержимое которой требуется.

mixed $default необязательный null

Содержимое по умолчанию/запасной вариант для $var.

Возвращает

mixed
Содержимое указанной переменной, если она задана, иначе $default.

getCurrentType()source public

getCurrentType( )

Получить текущий тип представления

Возвращает

string

getVars()source public

getVars( )

Возвращает список переменных, доступных в текущем контексте представления

Возвращает

array
Массив имён заданных переменных представления.

helpers()source public

helpers( )

Получить используемую реестр помощников в этом классе представления.

Возвращает

Cake\View\HelperRegistry

initialize()source public

initialize( )

Метод инициализации.

Свойства, такие как $helpers и т. д., не могут быть статически инициализированы в вашем пользовательском классе представления, так как они перезаписываются значениями из контроллера в конструкторе. Поэтому этот метод позволяет управлять ими по мере необходимости после создания экземпляра представления.

layout()source public

layout( string|null $name null )

Получить/установить имя файла макета для отображения шаблона внутри него. Указанное имя — это имя файла макета в /src/Template/Layout без расширения .ctp.

Параметры

string|null $name необязательный null

Имя файла макета для установки. Если null, возвращает текущее имя.

Возвращает

string|null

layoutPath()source public

layoutPath( string|null $path null )

Получить/установить путь к файлам макета.

Параметры

string|null $path необязательный null

Путь к файлам макета. Если null, возвращает текущий путь.

Возвращает

string|null

loadHelper()source public

loadHelper( string $name , array $config [] )

Загрузить помощника. Делегирует загрузку помощника в HelperRegistry::load()

Параметры

string $name

Имя помощника для загрузки.

array $config необязательный []

Настройки для помощника

Возвращает

Cake\View\Helper
объект построенного помощника.

См. также

\Cake\View\HelperRegistry::load()

pluginSplit()source public

pluginSplit( string $name , boolean $fallback true )

Разделяет имя плагина в формате точка на имя плагина и имя файла. Если в $name нет точки, то индекс 0 будет null. Проверяет, загружен ли плагин, иначе имя файла остаётся неизменным для имён файлов, содержащих точку

Параметры

string $name

Имя плагина, которое необходимо разделить.

boolean $fallback необязательный true

Если true, использует плагин, установленный в текущем запросе, когда загруженный плагин не найден

Возвращает

array
Массив с 2 индексами. 0 => имя плагина, 1 => имя файла

prepend()source public

prepend( string $name , mixed $value )

Добавляет в начало существующего или нового блока.

Добавление в начало нового блока создаст этот блок.

Параметры

string $name

Имя блока

mixed $value

Содержимое блока. Значение будет преобразовано в строку.

См. также

\Cake\View\ViewBlock::concat()

renderLayout()source public

renderLayout( string $content , string|null $layout null )

Отображает макет. Возвращает вывод из _render(). Возвращает false при ошибке. Несколько переменных созданы для использования в макете.

Параметры

string $content

Содержимое для отображения в шаблоне, обернутое окружающим макетом.

string|null $layout необязательный null

Имя макета

Возвращает

mixed
Выводимый результат или false при ошибке

Исключения

Cake\Core\Exception\Exception
если возникает ошибка в представлении.

События

View.beforeLayout $this, [$layoutFileName]
View.afterLayout $this, [$layoutFileName]

reset()source public

reset( string $name )

Сбросить содержимое блока. Это перезапишет всё существующее содержимое.

Параметры

string $name

Имя блока

См. также

\Cake\View\ViewBlock::set()

start()source public

start( string $name )

Начать захват вывода для 'блока'

Вы можете использовать start для блока несколько раз, чтобы добавить или вставить содержимое в режиме захвата.

// Append content to an existing block.
$this->start('content');
echo $this->fetch('content');
echo 'Some new content';
$this->end();

// Prepend content to an existing block
$this->start('content');
echo 'Some new content';
echo $this->fetch('content');
$this->end();

Параметры

string $name

Имя блока для захвата.

См. также

\Cake\View\ViewBlock::start()

template()source public

template( string|null $name null )

Получить/установить имя файла шаблона для отображения. Указанное имя — это имя файла в /src/Template/ без расширения .ctp.

Параметры

string|null $name необязательный null

Имя файла шаблона для установки. Если null, возвращает текущее имя.

Возвращает

string|null

templatePath()source public

templatePath( string|null $path null )

Получить/установить путь к файлам шаблонов.

Параметры

string|null $path необязательный null

Путь к файлам шаблонов. Если null, возвращает текущий путь.

Возвращает

string|null

theme()source public

theme( string|null $theme null )

Тема представления, которая будет использоваться.

Параметры

string|null $theme необязательный null

Имя темы. Если null, возвращает текущую тему.

Возвращает

string|null

uuid()source public

uuid( string $object , string $url )

Генерирует уникальный, неслучайный идентификатор DOM для объекта, основанный на типе объекта и целевом URL.

Параметры

строка $object

Тип объекта, например, 'форма' или 'ссылка'

строка $url

Целевой URL объекта

Возвращает

строка

_createCell()source protected

_createCell( string $className , string $action , string $plugin , array $options )

Создает и настраивает экземпляр ячейки.

Параметры

строка $className

Имя класса ячейки.

строка $action

Имя действия.

строка $plugin

Имя плагина.

массив $options

Параметры конструктора для ячейки.

Возвращает

Cake\View\Cell;

cell()source public

cell( string $cell , array $data [] , array $options [] )

Отображает заданную ячейку.

Пример:

// Taxonomy\View\Cell\TagCloudCell::smallList()
$cell = $this->cell('Taxonomy.TagCloud::smallList', ['limit' => 10]);

// App\View\Cell\TagCloudCell::smallList()
$cell = $this->cell('TagCloud::smallList', ['limit' => 10]);

Действие display будет использоваться по умолчанию, если действие не указано:

// Taxonomy\View\Cell\TagCloudCell::display()
$cell = $this->cell('Taxonomy.TagCloud');

Ячейки отображаются только при их выводе.

Параметры

строка $cell

Вы должны указать имя ячейки и, необязательно, действие ячейки. Например: TagCloud::smallList вызовет View\Cell\TagCloudCell::smallList(), действие display будет вызываться по умолчанию, если оно не указано.

массив $data необязательно []

Дополнительные аргументы для метода ячейки. Например: cell('TagCloud::smallList', ['a1' => 'v1', 'a2' => 'v2']) соответствует View\Cell\TagCloud::smallList(v1, v2)

массив $options необязательно []

Параметры конструктора для ячейки

Возвращает

Cake\View\Cell
Экземпляр ячейки

Выбрасывает

Cake\View\Exception\MissingCellException
Если класс ячейки не найден.
BadMethodCallException
Если класс ячейки не указал действие ячейки.

dispatchEvent()source public

dispatchEvent( string $name , array|null $data null , object|null $subject null )

Обертка для создания и отправки событий.

Возвращает отправленное событие.

Параметры

строка $name

Имя события.

массив|null $data необязательно null

Любое значение, которое вы хотите передать с этим событием, чтобы его могли прочитать слушатели.

объект|null $subject необязательно null

Объект, к которому относится это событие (по умолчанию $this).

Возвращает

Cake\Event\Event

eventManager()source public

eventManager( Cake\Event\EventManager $eventManager null )

Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.

Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов событий объекта, или для создания собственных событий и их запуска по желанию.

Параметры

Cake\Event\EventManager $eventManager необязательно null

устанавливаемый eventManager

Возвращает

Cake\Event\EventManager

log()source public

log( mixed $msg , integer|string $level LogLevel::ERROR , string|array $context [] )

Удобный метод для записи сообщения в журнал. Для получения дополнительной информации о записи в журналы см. Log::write().

Параметры

смешанное $msg

Сообщение журнала.

целое число|строка $level необязательно LogLevel::ERROR

Уровень ошибки.

строка|массив $context необязательно []

Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

логическое значение
Успешность записи в журнал.

requestAction()source public

requestAction( string|array $url , array $extra [] )

Вызывает метод контроллера из любого места. Может использоваться для связи контроллеров или подключения плагинов к главному приложению. requestAction может возвращать отрендеренные представления или извлекать возвращаемое значение из действий контроллеров.

Под капотом этот метод использует Router::reverse() для преобразования параметра $url в строковый URL. Вы должны использовать форматы URL, совместимые с Router::reverse().

Примеры

Базовый пример получения возвращаемого значения действия контроллера:

$variables = $this->requestAction('/articles/popular');

Базовый пример request action для извлечения отрендеренной страницы без макета:

$viewHtml = $this->requestAction('/articles/popular', ['return']);

Вы также можете передать URL в виде массива:

$vars = $this->requestAction(['controller' => 'articles', 'action' => 'popular']);

Передача других данных запроса

Вы можете передать данные POST, GET, COOKIE и другие данные в запрос, используя соответствующие ключи. Куки можно передавать с помощью ключа cookies. Параметры GET можно установить с помощью query, а данные POST можно отправить с помощью ключа post.

$vars = $this->requestAction('/articles/popular', [
  'query' => ['page' => 1],
  'cookies' => ['remember_me' => 1],
]);

Отправка значений среды или заголовков

По умолчанию действия, запускаемые с помощью этого метода, будут использовать глобальные значения $_SERVER и $_ENV. Если вы хотите переопределить эти значения для действия запроса, вы можете указать значения:

$vars = $this->requestAction('/articles/popular', [
  'environment' => ['CONTENT_TYPE' => 'application/json']
]);

Передача сессии

По умолчанию действия, запускаемые с помощью этого метода, будут использовать стандартный объект сессии. Если вы хотите использовать определенный экземпляр сессии, вам нужно указать его.

$vars = $this->requestAction('/articles/popular', [
  'session' => new Session($someSessionConfig)
]);

Параметры

строка|массив $url

URL в виде строки или массива. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные аргументы в параметре $url.

массив $extra необязательно []

Если массив включает ключ "return", он устанавливает autoRender в true. Также может использоваться для отправки данных GET/POST и передачи аргументов.

Возвращает

смешанное

Булево значение true или false при успехе/неудачи, или содержимое отрендеренного действия, если в $extra задан ключ "return".

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 , string|array|null|boolean $value null )

Сохраняет переменную или ассоциативный массив переменных для использования внутри шаблона.

Параметры

строка|массив $name

Строка или массив данных.

строка|массив|null|boolean $value необязательно null

Значение в случае, если $name — строка (которая затем работает как ключ). Не используется, если $name — ассоциативный массив, в противном случае служит значениями для ключей $name.

Возвращает

$this

viewBuilder()source public

viewBuilder( )

Получить используемый билдер представления.

Возвращает

Cake\View\ViewBuilder

viewOptions()source public

viewOptions( string|array|null $options null , boolean $merge true )

Получить/установить допустимые параметры представления в свойстве _validViewOptions объекта. Свойство создается как пустой массив, если оно не задано. Если вызывается без параметров, оно вернет текущий список допустимых параметров представления. См. createView().

Параметры

строка|массив|null $options необязательно null

строка или массив строк, которые нужно добавить в _validViewOptions.

логическое значение $merge необязательно true

Совмещать с существующими допустимыми параметрами представления или переопределять их. По умолчанию true.

Возвращает

массив
Обновленные параметры представления в виде массива.