Класс JsonView

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

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

_dataToSerialize()source protected

_dataToSerialize( array|string|boolean $serialize true )

Возвращает данные для сериализации.

Параметры

массив|строка|булево $serialize необязательно true

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

Возвращает

смешанный
Данные для сериализации.

_serialize()source protected

_serialize( array|string|boolean $serialize )

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

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

_jsonOptions Вы можете установить пользовательские параметры для json_encode() таким образом, например JSON_HEX_TAG | JSON_HEX_APOS.

Параметры

массив|строка|булево $serialize

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

Возвращает

строка|ложь
Сериализованные данные или boolean false, если сериализация невозможна.

render()source public

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

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

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

_serialize Для преобразования набора переменных представления в ответ JSON. Его значение может быть строкой для имени одной переменной или массивом для нескольких имён. Если true, все переменные представления будут сериализованы. Если оно установлено, нормальная шаблонная страница представления не будет отображаться. _jsonp Включает поддержку JSONP и оборачивает ответ в функцию обратного вызова, указанную в строке запроса. - Установка в true включает параметр строки запроса по умолчанию "callback". - Установка значения строки использует предоставленный параметр строки запроса для поиска имени обратного вызова JSONP.

Параметры

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

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

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

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

Возвращает

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

Исключения

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

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

Cake\View\SerializedView::render()

__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()

__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.

Параметры

строка|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, чтобы не генерировать исключения.

Возвращает

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

Выбрасывает

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

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

Возвращает

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

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

См. также

\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 необязательно []

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

Возвращает

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

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.

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

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

Возвращает

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

'json'

['_serialize', '_jsonOptions', '_jsonp']

'json'

'json'