Класс XmlView

$this->set(['posts' => $posts, '_serialize' => true]);

$this->set(compact('posts', 'users', 'stuff'));
$this->set('_serialize', true);

_serializeисточник protected

_serialize( array|string $serialize )

Сериализация переменных представления.

Специальные параметры

_xmlOptions Вы можете задать массив пользовательских опций для Xml::fromArray() таким образом, например, 'format' как 'attributes' вместо 'tags'.

Параметры

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

Имя(а) переменной(ых) представления, которая(ые) необходимо(ы) сериализовать

Возвращает

string
Сериализованные данные

__constructисточник 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источник public

loadHelpers( )

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

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

Cake\View\View::loadHelpers()

renderисточник public

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

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

Специальные параметры

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

Параметры

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

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

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

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

Возвращает

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

Исключение

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

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

Cake\View\View::render()

__getисточник public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

mixed
смешанный тип

__setисточник public

__set( string $name , mixed $value )

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

Параметры

строка $name

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

смешанный тип $value

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

_checkFilePathисточник protected

_checkFilePath( string $file , string $path )

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

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

Параметры

строка $file

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

строка $path

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

Возвращает

string
Путь к файлу

Исключение

InvalidArgumentException
\InvalidArgumentException

_elementCacheисточник protected

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

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

Параметры

строка $name

Имя элемента

массив $data

Данные

массив $options

Опции элемента

Возвращает

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

_evaluateисточник protected

_evaluate( string $viewFile , array $dataForView )

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

Параметры

строка $viewFile

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

массив $dataForView

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

Возвращает

string
Выводимый результат

_getElementFileNameисточник protected

_getElementFileName( string $name )

Поиск имени файла элемента, возвращает false при ошибке.

Параметры

строка $name

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

Возвращает

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

_getLayoutFileNameисточник protected

_getLayoutFileName( string|null $name null )

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

Параметры

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

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

Возвращает

string
Имя файла макета (.ctp).

Исключение

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

_getSubPathsисточник protected

_getSubPaths( string $basePath )

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

Параметры

строка $basePath

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

Возвращает

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

_getViewFileNamesource protected

_getViewFileName( string|null $name null )

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

Параметры

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

Действие контроллера для поиска имени файла шаблона

Возвращает

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

Выбрасывает

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

_inflectViewFileNamesource protected

_inflectViewFileName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_pathssource protected

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

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

Параметры

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

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

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

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

Возвращает

array
пути

_rendersource protected

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

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

Параметры

строка $viewFile

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

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

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

Возвращает

string
Вывод после рендера

Выбрасывает

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

Тригеры

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

_renderElementsource protected

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

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

Параметры

строка $file

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

массив $data

Данные для рендера

массив $options

Опции элемента

Возвращает

string
строка

Тригеры

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

appendsource public

append( string $name , mixed $value null )

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

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

Параметры

строка $name

Имя блока

смешанный $value необязательно null

Содержание блока.

См. также

Cake\View\ViewBlock::concat()

assignsource public

assign( string $name , mixed $value )

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

Параметры

строка $name

Имя блока

смешанный $value

Содержание блока.

См. также

Cake\View\ViewBlock::set()

autoLayoutsource public

autoLayout( boolean $autoLayout null )

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

Параметры

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

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

Возвращает

boolean|null
bool|null

blockssource public

blocks( )

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

Возвращает

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

См. также

Cake\View\ViewBlock::keys()

cachesource public

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

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

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

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

Параметры

вызываемая функция $block

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

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

Опции, определяющие ключ кэша и т.д.

Возвращает

string
Отрендеренное содержимое.

Выбрасывает

RuntimeException
Когда $options не хватает опции 'key'.

elementsource public

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

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

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

Параметры

строка $name

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

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

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

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

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

Возвращает

string
Отрендеренный элемент

Выбрасывает

Cake\View\Exception\MissingElementException
Когда элемент отсутствует и ignoreMissing равно false.

elementExistssource public

elementExists( string $name )

Проверяет существование элемента

Параметры

строка $name

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

Возвращает

boolean
Успех

endsource public

end( )

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

См. также

Cake\View\ViewBlock::end()

existssource public

exists( string $name )

Проверка существования блока

Параметры

строка $name

Имя блока

Возвращает

boolean
bool

extendsource public

extend( string $name )

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

Параметры

строка $name

Шаблон или элемент, с которым нужно «расширить» текущий.

Выбрасывает

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

fetchsource public

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

Получить содержимое блока. Если блок пуст или не определён, возвращается «».

Параметры

строка $name

Имя блока

строка $default необязательно ''

Текст по умолчанию

Возвращает

string
содержимое блока или $default, если блок не существует.

См. также

Cake\View\ViewBlock::get()

getsource public

get( string $var , mixed $default null )

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

Параметры

строка $var

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

смешанное $default необязательно null

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

Возвращает

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

getCurrentTypesource public

getCurrentType( )

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

Возвращает

string
строка

getVarssource public

getVars( )

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

Возвращает

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

helperssource public

helpers( )

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

Возвращает

Cake\View\HelperRegistry
\Cake\View\HelperRegistry

initializesource public

initialize( )

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

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

layoutsource public

layout( string $name null )

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

Параметры

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

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

Возвращает

string|null
строка|null

layoutPathsource public

layoutPath( string $path null )

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

Параметры

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

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

Возвращает

string|null
строка|null

loadHelpersource public

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

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

Параметры

строка $name

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

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

Параметры для помощи

Возвращает

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

См. также

Cake\Core\ObjectRegistry::load()

pluginSplitsource public

pluginSplit( string $name , boolean $fallback true )

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

Параметры

строка $name

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

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

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

Возвращает

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

prependsource public

prepend( string $name , mixed $value )

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

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

Параметры

строка $name

Имя блока

смешанное $value

Содержимое блока.

См. также

Cake\View\ViewBlock::concat()

renderLayoutsource public

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

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

Параметры

строка $content

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

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

Имя макета

Возвращает

mixed
Отрендеренный вывод или false при ошибке

Исключения

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

Вызывает

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

resetsource public

reset( string $name )

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

Параметры

строка $name

Имя блока

См. также

Cake\View\ViewBlock::set()

startsource 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();

Параметры

строка $name

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

См. также

Cake\View\ViewBlock::start()

templatesource public

template( string $name null )

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

Параметры

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

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

Возвращает

string|null
строка|null

templatePathsource public

templatePath( string $path null )

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

Параметры

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

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

Возвращает

string|null
строка|null

themesource public

theme( string $theme null )

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

Параметры

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

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

Возвращает

string|null
строка|null

uuidsource public

uuid( string $object , string $url )

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

Параметры

строка $object

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

строка $url

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

Возвращает

string
строка

_createCellsource protected

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

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

Параметры

строка $className

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

строка $action

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

строка $plugin

Имя плагина.

массив $options

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

Возвращает

Cake\View\Cell;
\Cake\View\Cell;

cellsource 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
Если в классе ячейки не указано действие ячейки.

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

Реализация

Cake\Event\EventDispatcherInterface::dispatchEvent()

eventManagersource public

eventManager( Cake\Event\EventManager $eventManager null )

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

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

Параметры

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

eventManager для установки

Возвращает

Cake\Event\EventManager
\Cake\Event\EventManager

Реализация

Cake\Event\EventDispatcherInterface::eventManager()

logsource public

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

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

Параметры

смешанное $msg

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

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

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

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

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

Возвращает

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

requestActionsource public

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

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

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

Примеры

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

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

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

$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 и переданных аргументов.

Возвращает

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

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 )

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

Параметры

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

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

строка|массив|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().

Параметры

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

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

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

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

Возвращает

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

'xml'

['_serialize', '_rootNode', '_xmlOptions']

'xml'

'xml'

null

''

'.ctp'

[]

[
    'viewVars', 'autoLayout', 'helpers', 'template', 'layout', 'name', 'theme',
    'layoutPath', 'templatePath', 'plugin', 'passedArgs'
]

[]

[]

[]

true

'default'

false

[]

'default'

null

[]

null

null

null

null

[]

'\Cake\Event\Event'

null

null

[]