Spec-Zone.ru › CakePHP 3.6

Класс SerializedView

Базовый класс для классов представлений, генерирующих сериализованные выходы, такие как JsonView и XmlView.

Cake\View\View implements Cake\Event\EventDispatcherInterface uses Cake\View\CellTrait , Cake\Event\EventDispatcherTrait , Cake\Log\LogTrait , Cake\Routing\RequestActionTrait , Cake\View\ViewVarsTrait
Extended by Cake\View\SerializedView

Прямые подклассы

  • Cake\View\JsonView
  • Cake\View\XmlView
Абстрактный
Пространство имён: Cake\View
Расположение: View/SerializedView.php

Унаследованные константы

  • NAME_ELEMENT, NAME_TEMPLATE, TYPE_ELEMENT, TYPE_LAYOUT, TYPE_TEMPLATE, TYPE_VIEW

Краткое описание свойств

  • $_responseType protected
    string
    Тип ответа.

Унаследованные магические свойства

  • Blocks, Breadcrumbs, Flash, Form, Html, Number, Paginator, Rss, Session, Text, Time, Url, view, viewPath _validViewOptions

Унаследованные свойства

  • Blocks, _current, _currentType, _ext, _helpers, _parents, _passedVars, _paths, _pathsForPlugin, _stack, _viewBlockClass, autoLayout, elementCache, hasRendered, helpers, layout, layoutPath, name, passedArgs, plugin, request, response, subDir, template, templatePath, theme, uuids _eventClass, _eventManager _viewBuilder, viewClass, viewVars

Краткое описание методов

  • __construct() public
    Конструктор
  • _serialize() abstract protected
    Сериализация переменных представления.
  • loadHelpers() public
    Загрузка помощников только если сериализация отключена.
  • render() public
    Вывод шаблона представления или возвращение сериализованных данных.

Подробное описание методов

__construct()source public

__construct( Cake\Http\ServerRequest $request = null , Cake\Http\Response $response = null , Cake\Event\EventManager $eventManager = null , array $viewOptions = [] )

Конструктор

Параметры

Cake\Http\ServerRequest $request необязательно null
Экземпляр запроса.
Cake\Http\Response $response необязательно null
Экземпляр ответа.
Cake\Event\EventManager $eventManager необязательно null
Экземпляр EventManager.
массив $viewOptions необязательно []
Массив параметров представления

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

Cake\View\View::__construct()

_serialize()source abstract protected

_serialize( array|string $serialize )

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

Параметры

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

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

Возвращает

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

loadHelpers()source public

loadHelpers( )

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

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

Cake\View\View::loadHelpers()

render()source public

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

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

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

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

Параметры

строка|булево|null $view необязательно null
Представление, которое отображается.
строка|null $layout необязательно null
Макет, который отображается.

Возвращает

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

Выбрасывает

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

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

Cake\View\View::render()

Методы, унаследованные от Cake\View\View

__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
Данные для включения в рендеринг представления.

Возвращает

строка
Вывод рендеринга

_getElementFileName()source protected

_getElementFileName( string $name , boolean $pluginCheck = true )

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

Параметры

строка $name
Имя элемента для поиска.
булево $pluginCheck необязательно true
  • если false, плагин запроса будет проигнорирован, если загруженный плагин не найден

Возвращает

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

_getLayoutFileName()source protected

_getLayoutFileName( string|null $name = null )

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

Параметры

string|null $name необязательно null
Имя макета для поиска.

Возвращает

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

Выбрасывает

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

_getSubPaths()source protected

_getSubPaths( string $basePath )

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

Параметры

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

Возвращает

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

_getViewFileName()source protected

_getViewFileName( string|null $name = null )

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

Параметры

string|null $name необязательно null
Действие контроллера для поиска имени файла шаблона.

Возвращает

string
Имя шаблона.

Выбрасывает

Cake\View\Exception\MissingTemplateException
при невозможности найти файл шаблона.

_inflectViewFileName()source protected

_inflectViewFileName( string $name )

Изменяет имя файла шаблона в формате с нижним регистром и разделителем «_».

Параметры

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

Возвращает

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

_paths()source protected

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

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

Параметры

string|null $plugin необязательно null
Необязательное имя плагина для сканирования файлов шаблонов.
boolean $cached необязательно true
Установите в значение false, чтобы принудительно обновить пути шаблонов. По умолчанию true.

Возвращает

array
Пути

_render()source protected

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

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

Параметры

string $viewFile
Имя файла шаблона.
array $data необязательно []

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

Возвращает

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

Выбрасывает

LogicException
Когда блок остаётся открытым.

Вызывает

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

_renderElement()source protected

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

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

Параметры

string $file
Путь к файлу элемента
array $data
Данные для отображения
array $options
Параметры элемента

Возвращает

string

Вызывает

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

append()source public

append( string $name , mixed $value = null )

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

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

Параметры

string $name
Имя блока
mixed $value необязательно null

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

Возвращает


$this

См. также

\Cake\View\ViewBlock::concat()

assign()source public

assign( string $name , mixed $value )

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

Параметры

string $name
Имя блока
mixed $value

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

Возвращает


$this

См. также

\Cake\View\ViewBlock::set()

autoLayout()source public deprecated

autoLayout( boolean|null $autoLayout = null )

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

Устарело

3.5.0 Используйте isAutoLayoutEnabled()/enableAutoLayout() вместо этого.

Параметры

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

Возвращает

boolean|null

blocks()source public

blocks( )

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

Возвращает

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

См. также

\Cake\View\ViewBlock::keys()

cache()source public

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

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

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

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

Параметры

callable $block
Блок кода, вывод которого нужно кешировать.
array $options необязательно []
Параметры, определяющие ключ кэша и т. д.

Возвращает

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

Выбрасывает

RuntimeException
Когда в $options отсутствует параметр 'key'.

element()source public

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

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

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

Параметры

string $name

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

array $data необязательно []
Массив данных, которые должны быть доступны отображаемому представлению (т. е. элементу).
array $options необязательно []

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

Возвращает

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

Выбрасывает

Cake\View\Exception\MissingElementException

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


elementExists()source public

elementExists( string $name )

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

Параметры

строка $name

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

Возвращает

boolean
Успех

enableAutoLayout()source public

enableAutoLayout( boolean $enable = true )

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

Параметры

логический $enable необязательно true
Логическое значение для включения/отключения.

Возвращает


$this

end()source public

end( )

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

Возвращает


$this

См. также

\Cake\View\ViewBlock::end()

exists()source public

exists( string $name )

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

Параметры

строка $name
Имя блока

Возвращает

boolean

extend()source public

extend( string $name )

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

Параметры

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

Возвращает


$this

Исключения

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

fetch()source public

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

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

Параметры

строка $name
Имя блока
строка $default необязательно ''
Текст по умолчанию

Возвращает

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

См. также

\Cake\View\ViewBlock::get()

get()source public

get( string $var , mixed $default = null )

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

Параметры

строка $var
Переменная представления, содержимое которой требуется.
смешанный $default необязательно null
Значение по умолчанию/резервное содержимое $var.

Возвращает

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

getCurrentType()source public

getCurrentType( )

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

Возвращает

string

getLayout()source public

getLayout( )

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

Возвращает

string

getLayoutPath()source public

getLayoutPath( )

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

Возвращает

string

getTemplate()source public

getTemplate( )

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

Возвращает

string

getTemplatePath()source public

getTemplatePath( )

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

Возвращает

string

getTheme()source public

getTheme( )

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

Возвращает

string|null

getVars()source public

getVars( )

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

Возвращает

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

helpers()source public

helpers( )

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

Возвращает

Cake\View\HelperRegistry

initialize()source public

initialize( )

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

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

isAutoLayoutEnabled()source public

isAutoLayoutEnabled( )

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

Возвращает

boolean

layout()source public устаревший

layout( string|null $name = null )

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

Устаревшее

3.5.0 Используйте getLayout()/setLayout() вместо этого.

Параметры

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

Возвращает

string|null

layoutPath()source public устаревший

layoutPath( string|null $path = null )

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

Устаревшее

3.5.0 Используйте getLayoutPath()/setLayoutPath() вместо этого.

Параметры

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

Возвращает

string|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. Проверяет, загружен ли плагин, иначе имя файла останется неизменным для имён файлов, содержащих точку.

Параметры

string $name
Имя плагина, которое вы хотите разделить.
boolean $fallback необязательно true
Если true, использует плагин, установленный в текущем запросе, когда загруженный плагин не найден.

Возвращает

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

prepend()source public

prepend( string $name , mixed $value )

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

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

Параметры

string $name
Имя блока
mixed $value

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

Возвращает


$this

См. также

\Cake\View\ViewBlock::concat()

renderLayout()source public

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

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

Параметры

string $content
Содержание для отображения в шаблоне, заключённое в окружающий макет.
string|null $layout необязательно null
Имя макета

Возвращает

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

Выбрасывает

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

Вызывает

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

reset()source public

reset( string $name )

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

Параметры

string $name
Имя блока

Возвращает


$this

См. также

\Cake\View\ViewBlock::set()

setLayout()source public

setLayout( string $name )

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

Параметры

string $name
Имя файла макета для установки.

Возвращает


$this

setLayoutPath()source public

setLayoutPath( string $path )

Установить путь для файлов макета.

Параметры

string $path
Путь для файлов макета.

Возвращает


$this

setTemplate()source public

setTemplate( string $name )

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

Параметры

string $name
Имя файла шаблона для установки.

Возвращает


$this

setTemplatePath()source public

setTemplatePath( string $path )

Установить путь для файлов шаблонов.

Параметры

string $path
Путь для файлов шаблонов.

Возвращает


$this

setTheme()source public

setTheme( string|null $theme )

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

Параметры

string|null $theme
Имя темы.

Возвращает


$this

start()source public

start( string $name )

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

Можно использовать start несколько раз для добавления или вставки содержимого в режиме захвата.

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

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

Параметры

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

Возвращает


$this

См. также

\Cake\View\ViewBlock::start()

template()source public устаревшее

template( string|null $name = null )

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

Устаревшее

3.5.0 Используйте getTemplate()/setTemplate() вместо этого.

Параметры

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

Возвращает

string|null

templatePath()source public устаревшее

templatePath( string|null $path = null )

Получение/установка пути для файлов шаблонов.

Устаревшее

3.5.0 Используйте getTemplatePath()/setTemplatePath() вместо этого.

Параметры

string|null $path необязательно null
Путь для файлов шаблонов. Если null, возвращает текущий путь.

Возвращает

string|null

theme()source public устаревшее

theme( string|null $theme = null )

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

Устаревшее

3.5.0 Используйте getTheme()/setTheme() вместо этого.

Параметры

string|null $theme необязательно null
Имя темы. Если null, возвращает текущую тему.

Возвращает

string|null

uuid()source public

uuid( string $object , string $url )

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

Параметры

string $object
Тип объекта, например 'форма' или 'ссылка'
string $url
Целевой URL объекта

Возвращает

string

Методы, используемые из Cake\View\CellTrait

_createCell()source protected

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

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

Параметры

string $className
Имя класса ячейки.
string $action
Имя действия.
string $plugin
Имя плагина.
array $options
Параметры конструктора ячейки.

Возвращает

Cake\View\Cell

cell()source protected

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');

Ячейки не отображаются, пока не будут выведены.

Параметры

string $cell

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

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

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

array $options необязательно []
Параметры конструктора ячейки

Возвращает

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

Выбрасывает

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

Методы, используемые из Cake\Event\EventDispatcherTrait

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 для этого объекта.

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

Устарело

3.5.0 Используйте getEventManager()/setEventManager() вместо этого.

Параметры

Cake\Event\EventManager $eventManager необязательно null
менеджер событий для установки

Возвращает

Cake\Event\EventManager

getEventManager()source public

getEventManager( )

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

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

Возвращает

Cake\Event\EventManager

setEventManager()source public

setEventManager( Cake\Event\EventManager $eventManager )

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

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

Параметры

Cake\Event\EventManager $eventManager
менеджер событий для установки

Возвращает


$this

Методы, используемые из Cake\Log\LogTrait

log()source public

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

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

Параметры

смешанный $msg
Сообщение для журнала.
целое число|строка $level необязательно LogLevel::ERROR
Уровень ошибки.
строка|массив $context необязательно []
Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

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

Методы, используемые из Cake\Routing\RequestActionTrait

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)
]);

Устарело

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

Параметры

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

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

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

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

Возвращает

смешанное

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


Методы, используемые из Cake\View\ViewVarsTrait

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.
boolean $merge необязательно true

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

Возвращает

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

Магические методы, унаследованные от Cake\Event\EventDispatcherInterface

getEventManager()

Подробное описание свойств

$_responseTypesource

protected строка

Тип ответа.

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.6/class-Cake.View.SerializedView.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API