Класс JsonView

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

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

_dataToSerializeисходный код protected

_dataToSerialize( array|string|boolean $serialize true )

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

Параметры

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

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

Возвращает

mixed
Данные для сериализации.

_serializeисходный код protected

_serialize( array|string|boolean $serialize )

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

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

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

Параметры

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

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

Возвращает

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

renderисходный код 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

Макет, который отображается.

Возвращает

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

Вызывает

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

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

Cake\View\SerializedView::render()

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

__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
при невозможности найти макет

_getSubPathssource protected

_getSubPaths( string $basePath )

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

Параметры

строка $basePath

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

Возвращает

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

_getViewFileNamesource protected

_getViewFileName( string|null $name null )

Возвращает имя файла шаблона для данного действия (.ctp) в виде строки. Имена действий с использованием CamelCase будут преобразовываться в нижний регистр с символом подчеркивания по умолчанию. Это означает, что у вас могут быть имена действий с использованием CamelCase, которые ссылаются на представления 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
При отсутствии опции 'key' в $options.

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 )

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

Параметры

string $name

Имя блока

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

boolean
bool

extendsource public

extend( string $name )

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

Параметры

string $name

Шаблон или элемент для 'расширения' текущего.

Исключения

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

fetchsource public

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

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

Параметры

string $name

Имя блока

string $default optional ''

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

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

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

См. также

Cake\View\ViewBlock::get()

getsource public

get( string $var , mixed $default null )

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

Параметры

string $var

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

mixed $default optional null

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

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

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

getCurrentTypesource public

getCurrentType( )

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

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

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

Параметры

string $name optional null

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

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

string|null
string|null

layoutPathsource public

layoutPath( string $path null )

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

Параметры

string $path optional null

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

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

string|null
string|null

loadHelpersource public

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

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

Параметры

string $name

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

array $config optional []

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

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

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

См. также

Cake\Core\ObjectRegistry::load()

pluginSplitsource public

pluginSplit( string $name , boolean $fallback true )

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

Параметры

string $name

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

boolean $fallback optional true

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

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

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

prependsource public

prepend( string $name , mixed $value )

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

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

Параметры

string $name

Имя блока

mixed $value

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

См. также

Cake\View\ViewBlock::concat()

renderLayoutsource public

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

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

Параметры

string $content

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

string|null $layout optional null

Имя макета

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

mixed
Результат рендеринга или false при ошибке

Исключения

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

Вызываемые события

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

resetsource public

reset( string $name )

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

Параметры

string $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();

Параметры

string $name

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

См. также

Cake\View\ViewBlock::start()

templatesource public

template( string $name null )

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

Параметры

string $name optional null

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

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

string|null
string|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

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

Возвращает

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

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

Возвращает

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.

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

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

Возвращает

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

'json'

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

'json'

'json'

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

[]