Класс XmlView

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

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

_serialize()source protected

_serialize( array|string $serialize )

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

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

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

Параметры

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

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

Возвращает

строка
Сериализованные данные

__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 , boolean $pluginCheck true )

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

Параметры

строка $name

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

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

• если 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) в виде строки. Имена действий с верхним регистром (CamelCased) по умолчанию преобразуются в нижний регистр с символом подчёркивания (under_scored). Это означает, что вы можете иметь имена действий с верхним регистром, которые ссылаются на представления long_action_names.ctp. Вы можете изменить правило инфлексии, переопределив _inflectViewFileName.

Параметры

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

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

Возвращает

строка
Имя файла шаблона

Выбрасывает

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

_inflectViewFileName()source protected

_inflectViewFileName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_paths()source protected

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

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

Параметры

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

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

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

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

Возвращает

массив
пути

_render()source protected

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

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

Параметры

строка $viewFile

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

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

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

Возвращает

строка
Отображаемый вывод

Выбрасывает

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

Вызывает

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

_renderElement()source protected

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

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

Параметры

строка $file

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

массив $data

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

массив $options

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

Возвращает

строка

Вызывает

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

append()source public

append( string $name , mixed $value null )

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

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

Параметры

строка $name

Имя блока

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

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

См. также

\Cake\View\ViewBlock::concat()

assign()source public

assign( string $name , mixed $value )

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

Параметры

строка $name

Имя блока

смешанный $value

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

См. также

\Cake\View\ViewBlock::set()

autoLayout()source public

autoLayout( boolean|null $autoLayout null )

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

Параметры

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

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

Возвращает

логическое значение|null

blocks()source public

blocks( )

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

Возвращает

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

См. также

\Cake\View\ViewBlock::keys()

cache()source public

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

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

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

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

Параметры

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

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

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

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

Возвращает

строка
Отрендеренный контент.

Выбрасывает

RuntimeException
Если в $options отсутствует опция 'key'.

element()source 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, чтобы не генерировать исключения. - plugin - Установка в false заставит использовать элемент приложения из шаблонов плагина, когда плагин имеет элемент с таким же именем. По умолчанию true

Возвращает

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

Выбрасывает

Cake\View\Exception\MissingElementException

Когда элемент отсутствует, а ignoreMissing равен false.

elementExists()source public

elementExists( string $name )

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

Параметры

строка $name

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

Возвращает

булево
Успех

end()source public

end( )

Завершение блока захвата. Комплементарная функция к View::start()

См. также

\Cake\View\ViewBlock::end()

exists()source public

exists( string $name )

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

Параметры

строка $name

Имя блока

Возвращает

булево

extend()source public

extend( string $name )

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

Параметры

строка $name

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

Выбрасывает

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

fetch()source public

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

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

Параметры

строка $name

Имя блока

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

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

Возвращает

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

См. также

\Cake\View\ViewBlock::get()

get()source public

get( string $var , mixed $default null )

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

Параметры

строка $var

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

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

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

Возвращает

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

getCurrentType()source public

getCurrentType( )

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

Возвращает

строка

getVars()source public

getVars( )

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

Возвращает

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

helpers()source public

helpers( )

Получить реестр помощников, используемый этим классом View.

Возвращает

Cake\View\HelperRegistry

initialize()source public

initialize( )

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

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

layout()source public

layout( string|null $name null )

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

Параметры

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

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

Возвращает

строка|null

layoutPath()source public

layoutPath( string|null $path null )

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

Параметры

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

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

Возвращает

строка|null

loadHelper()source public

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

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

Параметры

строка $name

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

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

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

Возвращает

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

См. также

\Cake\View\HelperRegistry::load()

pluginSplit()source public

pluginSplit( string $name , boolean $fallback true )

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

Параметры

строка $name

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

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

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

Возвращает

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

prepend()source public

prepend( string $name , mixed $value )

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

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

Параметры

строка $name

Имя блока

смешанный $value

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

См. также

\Cake\View\ViewBlock::concat()

renderLayout()source public

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

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

Параметры

строка $content

Содержание, которое должно отобразиться в шаблоне, заключённое в окружающий макет.

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

Имя макета

Возвращает

смешанный тип
Вывод, отображенный, или false при ошибке

Выбрасывает

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

Вызывает

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

reset()source public

reset( string $name )

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

Параметры

строка $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();

Параметры

строка $name

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

См. также

\Cake\View\ViewBlock::start()

template()source public

template( string|null $name null )

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

Параметры

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

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

Возвращает

строка|null

templatePath()source public

templatePath( string|null $path null )

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

Параметры

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

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

Возвращает

строка|null

theme()source public

theme( string|null $theme null )

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

Параметры

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

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

Возвращает

строка|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

менеджер событий для установки

Возвращает

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. Если вы хотите переопределить эти значения для действия request action, вы можете указать значения:

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

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

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

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

Устаревшее

3.3.0 Вам следует переработать код, чтобы использовать View Cells вместо этого метода.

Параметры

строка|массив $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 , mixed $value null )

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

Параметры

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

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

смешанный $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.

Возвращает

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

'xml'

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

'xml'

'xml'