Класс 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
-
Cake\View\SerializedView
Прямые подклассы
Унаследованные константы
Резюме свойств
-
$_responseTypeprotectedТип ответа.string
Наследованные магические свойства
-
Blocks,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Конструктор
- Сериализация переменных представления.
- 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 Для преобразования набора переменных представления в сериализованную форму. Его значение может быть строкой для имени одной переменной или массивом для нескольких имён. Если истинно, все переменные представления будут сериализованы. Если не задано, будет отображен обычный шаблон представления.
Параметры
- строка|логическое|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 - если ложь, игнорирует плагин запроса, если загружен необработанный плагин
Возвращает
строка|ложьСтрока имени файла элемента или ложь, когда файл не найден.
_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. Имена действий с верблюжьей нотацией будут преобразовываться в нижний регистр с подчёркиванием по умолчанию. Это означает, что вы можете иметь имена действий с верблюжьей нотацией, которые ссылаются на представления 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 )
Отображает элемент и вызывает обратные вызовы before и 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
autoLayout( boolean|null $autoLayout null )
Включает или выключает стандартный режим CakePHP по применению файлов макета. Включено по умолчанию. Выключение означает, что макеты не будут автоматически применяться к отображаемым шаблонам.
Устарело
3.5.0 Используйте isAutoLayoutEnabled()/enableAutoLayout() вместо этого.Параметры
- boolean|null
$autoLayoutнеобязательно null - Булево значение для включения/выключения. Если null, возвращает текущее значение.
Возвращает
boolean|nullblocks()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, чтобы вызвать обратные вызовы обработчика 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 - Имя блока
Возвращает
booleanextend()source public
extend( string $name )
Обеспечивает расширение/наследование шаблона или элемента. Представления могут расширять родительское представление и заполнять блоки в родительском шаблоне.
Параметры
- строка
$name - Шаблон или элемент, с которым необходимо расширить текущий.
Возвращает
$this
Исключение
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( )
Получение текущего типа представления
Возвращает
строкаgetLayout()source public
getLayout( )
Получение имени файла макета для отображения шаблона. Указанное имя является именем файла макета в /src/Template/Layout без расширения .ctp.
Возвращает
строкаgetTemplate()source public
getTemplate( )
Получение имени файла шаблона для отображения. Указанное имя является именем файла в /src/Template/<подпапка> без расширения .ctp.
Возвращает
строкаgetTemplatePath()source public
getTemplatePath( )
Получение пути к файлам шаблонов.
Возвращает
строкаgetVars()source public
getVars( )
Возвращает список переменных, доступных в текущем контексте представления
Возвращает
массивМассив имён установленных переменных представления.
helpers()source public
helpers( )
Получение реестра помощников, используемого этим классом View.
Возвращает
Cake\View\HelperRegistryinitialize()source public
initialize( )
Метод инициализации.
Свойства, такие как $helpers и т.д., не могут быть статически инициализированы в вашем пользовательском классе представления, поскольку они перезаписываются значениями из контроллера в конструкторе. Этот метод позволяет манипулировать ими по мере необходимости после создания экземпляра представления.
isAutoLayoutEnabled()source public
isAutoLayoutEnabled( )
Возвращает, включён ли стандартный режим CakePHP для применения файлов макета. Отключение означает, что макеты не будут автоматически применяться к отображаемым представлениям.
Возвращает
booleanlayout()source public
layout( string|null $name null )
Получение/установка имени файла макета для отображения шаблона. Указанное имя является именем файла макета в /src/Template/Layout без расширения .ctp.
Устарело
3.5.0 Используйте getLayout()/setLayout() вместо этого.Параметры
- строка|null
$nameнеобязательно null - Имя файла макета для установки. Если null, возвращает текущее имя.
Возвращает
строка|nulllayoutPath()source public
layoutPath( string|null $path null )
Получение/установка пути к файлам макета.
Устарело
3.5.0 Используйте getLayoutPath()/setLayoutPath() вместо этого.Параметры
- строка|null
$pathнеобязательно null - Путь к файлам макета. Если null, возвращает текущий путь.
Возвращает
строка|nullloadHelper()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 )
Разделяет имя плагина в формате точка (dot) на имя плагина и имя файла. Если в $name нет точки, то индекс 0 будет null. Проверяет, загружен ли плагин, в противном случае имя файла останется неизменным для имён файлов, содержащих точку.
Параметры
- строка
$name - Имя плагина, которое нужно разделить.
- логическое
$fallbackнеобязательно true - Если true, используется плагин, установленный в текущем запросе, когда загруженный плагин не найден.
Возвращает
массивМассив с 2 индексами. 0 => имя плагина, 1 => имя файла
prepend()source public
prepend( string $name , mixed $value )
Добавляет в начало существующего или нового блока.
Добавление в новый блок создаст блок.
Параметры
- строка
$name - Имя блока
- смешанное
$value Содержание блока. Значение будет преобразовано в строку.
Возвращает
$this
См. также
\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 - Имя блока
Возвращает
$this
См. также
\Cake\View\ViewBlock::set()setLayout()source public
setLayout( string $name )
Установить имя файла макета для отображения шаблона внутри него. Указанное имя — имя файла макета в /src/Template/Layout без расширения .ctp.
Параметры
- строка
$name - Имя файла макета для установки.
Возвращает
$this
setLayoutPath()source public
setLayoutPath( string $path )
Установить путь для файлов макетов.
Параметры
- строка
$path - Путь для файлов макетов.
Возвращает
$this
setTemplate()source public
setTemplate( string $name )
Установить имя файла шаблона для отображения. Указанное имя — имя файла в /src/Template/
Параметры
- строка
$name - Имя файла шаблона для установки.
Возвращает
$this
setTemplatePath()source public
setTemplatePath( string $path )
Установить путь для файлов шаблонов.
Параметры
- строка
$path - Путь для файлов шаблонов.
Возвращает
$this
setTheme()source public
setTheme( string|null $theme )
Установить тему представления для использования.
Параметры
- строка|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(); Параметры
- строка
$name - Имя блока для захвата.
Возвращает
$this
См. также
\Cake\View\ViewBlock::start()template()source public
template( string|null $name null )
Получить/установить имя файла шаблона для отображения. Указанное имя — имя файла в /src/Template/
Устарело
3.5.0 Используйте getTemplate()/setTemplate() вместо этого.Параметры
- строка|null
$nameнеобязательно null - Имя файла шаблона для установки. Если null, возвращает текущее имя.
Возвращает
строка|nulltemplatePath()source public
templatePath( string|null $path null )
Получить/установить путь для файлов шаблонов.
Устарело
3.5.0 Используйте getTemplatePath()/setTemplatePath() вместо этого.Параметры
- строка|null
$pathнеобязательно null - Путь для файлов шаблонов. Если null, возвращает текущий путь.
Возвращает
строка|nulltheme()source public
theme( string|null $theme null )
Тему представления для использования.
Устарело
3.5.0 Используйте getTheme()/setTheme() вместо этого.Параметры
- строка|null
$themeнеобязательно null - Имя темы. Если null, возвращает текущую тему.
Возвращает
строка|nulluuid()source public
uuid( string $object , string $url )
Генерирует уникальный, неслучайный идентификатор DOM для объекта на основе типа объекта и целевого URL.
Параметры
- строка
$object - Тип объекта, например, 'форма' или 'ссылка'
- строка
$url - Целевой URL объекта
Возвращает
строкаМетоды, используемые из Cake\View\CellTrait
_createCell()source protected
_createCell( string $className , string $action , string $plugin , array $options )
Создать и настроить экземпляр ячейки.
Параметры
- строка
$className - Имя класса ячейки.
- строка
$action - Имя действия.
- строка
$plugin - Имя плагина.
- массив
$options - Параметры конструктора ячейки.
Возвращает
Cake\View\Cellcell()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'); Ячейки не отображаются, пока они не будут выведены.
Параметры
- строка
$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
Если класс ячейки не указал действие ячейки.
Методы, используемые из Cake\Event\EventDispatcherTrait
dispatchEvent()source public
dispatchEvent( string $name , array|null $data null , object|null $subject null )
Обёртка для создания и отправки событий.
Возвращает отправленное событие.
Параметры
- string
$name - Имя события.
- array|null
$dataoptional null Любое значение, которое вы хотите передать вместе с этим событием, чтобы его могли прочитать слушатели.
- object|null
$subjectoptional null Объект, к которому относится это событие ($this по умолчанию).
Возвращает
Cake\Event\EventeventManager()source public
eventManager( Cake\Event\EventManager $eventManager null )
Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.
Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов для событий объекта, или создавать свои собственные события и вызывать их по своему усмотрению.
Устарело
3.5.0 Используйте getEventManager()/setEventManager() вместо этого.Параметры
-
Cake\Event\EventManager$eventManageroptional null - менеджер событий для установки
Возвращает
Cake\Event\EventManagergetEventManager()source public
getEventManager( )
Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.
Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов для событий объекта, или создавать свои собственные события и вызывать их по своему усмотрению.
Возвращает
Cake\Event\EventManagersetEventManager()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() для получения дополнительной информации о записи в журналы.
Параметры
- mixed
$msg - Сообщение журнала.
- integer|string
$leveloptional LogLevel::ERROR - Уровень ошибки.
- string|array
$contextoptional [] - Дополнительные данные журнала, относящиеся к этому сообщению.
Возвращает
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'); Базовый пример действия 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)
]); Устарело
3.3.0 Вы должны переработать свой код, чтобы использовать View Cells вместо этого метода.Параметры
- string|array
$url Строковый или массивный URL. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные аргументы в параметре $url.
- array
$extraoptional [] Если массив включает ключ "return", он устанавливает autoRender в true. Также может использоваться для отправки данных GET/POST и переданных аргументов.
Возвращает
mixedБулевое значение true или false при успехе/неудачи, или содержимое отображаемого действия, если в $extra установлен ключ 'return'.
Методы, используемые из Cake\View\ViewVarsTrait
createView()source public
createView( string|null $viewClass null )
Создаёт экземпляр класса представления на основе текущей конфигурации.
Параметры
- string|null
$viewClassoptional null - Необязательное имя пространственно-разделенного класса представления для создания экземпляра.
Возвращает
Cake\View\ViewВыбрасывает
Cake\View\Exception\MissingViewExceptionЕсли класс представления не был найден.
set()source public
set( string|array $name , mixed $value null )
Сохраняет переменную или ассоциативный массив переменных для использования внутри шаблона.
Параметры
- string|array
$name - Строка или массив данных.
- mixed
$valueoptional null Значение в случае, если $name является строкой (которая затем работает как ключ). Не используется, если $name является ассоциативным массивом, в противном случае служит значениями для ключей $name.
Возвращает
$this
viewBuilder()source public
viewBuilder( )
Получить используемый билдер представлений.
Возвращает
Cake\View\ViewBuilderviewOptions()source public
viewOptions( string|array|null $options null , boolean $merge true )
Получение/установка допустимых опций представления в свойстве _validViewOptions объекта. Свойство создается как пустой массив, если оно не задано. Если вызывается без параметров, возвращает текущий список допустимых опций представления. См. createView().
Параметры
- string|array|null
$optionsoptional null - строка или массив строк, которые нужно добавить к _validViewOptions.
- boolean
$mergeoptional true Требуется ли слияние с существующими допустимыми опциями представления или их переопределение. По умолчанию
true.
Возвращает
arrayОбновленные опции представления в виде массива.
Магические методы, унаследованные от Cake\Event\EventDispatcherInterface
getEventManager() |
Подробное описание свойств
© 2005–2018 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.5/class-Cake.View.SerializedView.html