Класс AjaxView
Класс представления, используемый для ответов AJAX. В настоящее время он только переключает шаблон по умолчанию и устанавливает тип ответа — по умолчанию это text/html.
- Cake\View\View реализует Cake\Event\EventDispatcherInterface использует Cake\View\CellTrait , Cake\Event\EventDispatcherTrait , Cake\Log\LogTrait , Cake\Routing\RequestActionTrait , Cake\View\ViewVarsTrait
-
Cake\View\AjaxView
Унаследованные константы
Краткое описание свойств
-
$layoutpublicstring
Унаследованные магические свойства
-
Blocks,Flash,Form,Html,Number,Paginator,Rss,Session,Text,Time,Url,view,viewPath_validViewOptions
Унаследованные свойства
-
Blocks,_current,_currentType,_ext,_helpers,_parents,_passedVars,_paths,_pathsForPlugin,_stack,autoLayout,elementCache,hasRendered,helpers,layoutPath,name,passedArgs,plugin,request,response,subDir,template,templatePath,theme,uuids_eventClass,_eventManager_viewBuilder,viewClass,viewVars
Краткое описание методов
- __construct() 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 - Объект менеджера событий.
- массив
$viewOptionsнеобязательно [] - Параметры представления.
Переопределяет
Cake\View\View::__construct() Методы, унаследованные от 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.
Возвращает
строкаПуть к файлу
Выбрасывает
ИсключениеНедействительногоАргумента_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, будет игнорировать плагин запроса, если плагин не загружен
Возвращает
строка|ложьСтрока имени файла элемента или ложь, если файл не найден.
_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) в виде строки. Имена действий с верблюжьей нотацией будут преобразованы в нижний регистр с подчёркиванием по умолчанию. Это означает, что вы можете иметь имена действий с верблюжьей нотацией, которые ссылаются на представления с именами в нижнем регистре с подчёркиванием. Можно изменить правило преобразования, переопределив _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 )
Возвращает все возможные пути для поиска файлов представления в порядке
Параметры
- 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 Содержимое блока. Значение будет преобразовано в строку.
См. также
\Cake\View\ViewBlock::concat()assign()source public
assign( string $name , mixed $value )
Установить содержимое блока. Это перезапишет любое существующее содержимое.
Параметры
- string
$name - Имя блока
- mixed
$value Содержимое блока. Значение будет преобразовано в строку.
См. также
\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 )
Проверяет, существует ли элемент
Параметры
- string
$name Имя файла шаблона в папке /src/Template/Element/, или
MyPlugin.templateдля проверки элемента шаблона из MyPlugin. Если элемент не найден в плагине, будет выполнен поиск в обычном порядке.
Возвращает
booleanУспешно
enableAutoLayout()source public
enableAutoLayout( boolean $enable true )
Включает или выключает обычный режим CakePHP для применения файлов макета. Включено по умолчанию. Выключение означает, что макеты не будут автоматически применяться к рендеримым представлениям.
Параметры
- boolean
$enableнеобязательно true - Булево значение для включения/выключения.
end()source public
end( )
Закончить захват блока. Комплементарное View::start()
См. также
\Cake\View\ViewBlock::end()exists()source public
exists( string $name )
Проверить, существует ли блок
Параметры
- string
$name - Имя блока
Возвращает
booleanextend()source public
extend( string $name )
Предоставляет расширение/наследование шаблона или элемента. Представления могут расширять родительское представление и заполнять блоки в родительском шаблоне.
Параметры
- string
$name - Шаблон или элемент, с которым нужно расширить текущий.
Выбрасывает
LogicExceptionпри расширении шаблона самим собой или создании циклов расширения.
LogicException
при расширении элемента, который не существует
fetch()source public
fetch( string $name , string $default '' )
Получить содержимое блока. Если блок пуст или не определён, возвращается пустая строка.
Параметры
- строка
$name - Имя блока
- строка
$defaultнеобязательно '' - Текстовое значение по умолчанию
Возвращает
строкаСодержимое блока или значение по умолчанию, если блок не существует.
См. также
\Cake\View\ViewBlock::get()get()source public
get( string $var , mixed $default null )
Возвращает содержимое заданной переменной представления.
Параметры
- строка
$var - Имя переменной представления, содержимое которой нужно получить.
- смешанный
$defaultнеобязательно null - Значение по умолчанию/запасной контент переменной $var.
Возвращает
смешанныйСодержимое указанной переменной, если она задана, в противном случае - значение по умолчанию.
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( )
Получить реестр помощников, используемый этим классом представления.
Возвращает
Cake\View\HelperRegistryinitialize()source public
initialize( )
Метод инициализации.
Свойства, такие как $helpers и т. д., не могут быть инициализированы статически в вашем пользовательском классе представления, так как они перезаписываются значениями из контроллера в конструкторе. Поэтому этот метод позволяет манипулировать ими по мере необходимости после создания экземпляра представления.
isAutoLayoutEnabled()source public
isAutoLayoutEnabled( )
Возвращает, включен ли стандартный режим CakePHP для применения файлов макета. Выключение означает, что макеты не будут автоматически применяться к рендеруемых представлениям.
Возвращает
булевоlayout()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()loadHelpers()source public
loadHelpers( )
Взаимодействие с HelperRegistry для загрузки всех помощников.
pluginSplit()source public
pluginSplit( string $name , boolean $fallback true )
Разделяет имя плагина в формате с точкой на имя плагина и имя файла. Если в $name нет точки, то индекс 0 будет null. Проверяет, загружен ли плагин, иначе имя файла останется неизменным для имён файлов, содержащих точку.
Параметры
- строка
$name - Имя плагина для разделения.
- булево
$fallbackнеобязательно true - Если true, использует плагин, установленный в текущем запросе, когда загруженный плагин не найден.
Возвращает
массивМассив с 2 индексами. 0 => имя плагина, 1 => имя файла
prepend()source public
prepend( string $name , mixed $value )
Добавляет контент в начало существующего или нового блока.
Добавление в новый блок создаст блок.
Параметры
- строка
$name - Имя блока
- смешанный
$value Содержимое блока. Значение будет преобразовано в строку.
См. также
\Cake\View\ViewBlock::concat()render()source public
render( string|false|null $view null , string|null $layout null )
Отображает представление для заданного файла шаблона и макета.
Render вызывает колбэки помощников, которые срабатывают до и после отрисовки шаблона, а также до и после макета. Колбэки помощников вызываются:
beforeRenderafterRenderbeforeLayoutafterLayout
Если View::$autoRender имеет значение false и не указан $layout, шаблон будет возвращён в исходном виде.
Имена шаблона и макета могут указывать на шаблоны/макеты плагинов. Используя синтаксис Plugin.template, можно использовать шаблон/макет плагина вместо приложения. Если выбранный плагин не найден, шаблон будет расположен в стандартном пути к представлениям.
Параметры
- string|false|null
$viewнеобязательный null - Имя файла представления для использования
- string|null
$layoutнеобязательный null - Используемый макет.
Возвращает
string|nullСодержимое, отрендеренное, или null, если содержимое уже было отрендеренно и возвращено ранее.
Выбрасывает
Cake\Core\Exception\ExceptionЕсли произошла ошибка в представлении.
Вызывает
View.beforeRender $this, [$viewFileName]View.afterRender $this, [$viewFileName]
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 - Имя блока
См. также
\Cake\View\ViewBlock::set()setLayout()source public
setLayout( string $name )
Установить имя файла макета для отрисовки шаблона внутри него. Указанное имя — имя файла макета в /src/Template/Layout без расширения .ctp.
Параметры
- string
$name - Имя файла макета для установки.
setLayoutPath()source public
setLayoutPath( string $path )
Установить путь для файлов макета.
Параметры
- string
$path - Путь к файлам макета.
setTemplate()source public
setTemplate( string $name )
Установить имя файла шаблона для отрисовки. Указанное имя — имя файла в /src/Template/
Параметры
- string
$name - Имя файла шаблона для установки.
setTemplatePath()source public
setTemplatePath( string $path )
Установить путь для файлов шаблонов.
Параметры
- string
$path - Путь к файлам шаблонов.
setTheme()source public
setTheme( string $theme )
Установить используемую тему представления.
Параметры
- string
$theme - Имя темы.
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 - Имя блока для захвата.
См. также
\Cake\View\ViewBlock::start()template()source public
template( string|null $name null )
Получить/установить имя файла шаблона для отрисовки. Указанное имя — имя файла в /src/Template/
Устарело
3.5.0 Используйте getTemplate()/setTemplate() вместо этого.Параметры
- string|null
$nameнеобязательный null - Имя файла шаблона для установки. Если null, возвращает текущее имя.
Возвращает
string|nulltemplatePath()source public
templatePath( string|null $path null )
Получить/установить путь к файлам шаблонов.
Устарело
3.5.0 Используйте getTemplatePath()/setTemplatePath() вместо этого.Параметры
- string|null
$pathнеобязательный null - Путь к файлам шаблонов. Если null, возвращает текущий путь.
Возвращает
string|nulltheme()source public
theme( string|null $theme null )
Используемая тема представления.
Устарело
3.5.0 Используйте getTheme()/setTheme() вместо этого.Параметры
- string|null
$themeнеобязательный null - Имя темы. Если null, возвращает текущую тему.
Возвращает
string|nulluuid()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\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'); Ячейки не отображаются, пока не будут выведены на экран.
Параметры
- 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 )
Обёртка для создания и отправки событий.
Возвращает событие, которое было отправлено.
Параметры
- string
$name - Имя события.
- array|null
$dataнеобязательно null Любое значение, которое вы хотите передать вместе с этим событием, чтобы его могли прочитать слушатели.
- object|null
$subjectнеобязательно null Объект, к которому относится это событие ($this по умолчанию).
Возвращает
Cake\Event\EventeventManager()source public
eventManager( Cake\Event\EventManager $eventManager null )
Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.
Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов для событий объекта, или создавать свои собственные события и вызывать их по желанию.
Устарело
3.5.0 Используйте getEventManager()/setEventManager() вместо этого.Параметры
-
Cake\Event\EventManager$eventManagerнеобязательно null - устанавливаемый eventManager
Возвращает
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 - устанавливаемый 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
$levelнеобязательно LogLevel::ERROR - Уровень ошибки.
- string|array
$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'); Базовый пример 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
$extraнеобязательно [] Если массив включает ключ "return", он устанавливает autoRender в true. Также может быть использован для отправки данных GET/POST и передачи аргументов.
Возвращает
mixedБулево значение true или false при успехе/неудаче или содержимое рендеренного действия, если в $extra установлен ключ "return".
Методы, используемые из Cake\View\ViewVarsTrait
createView()source public
createView( string|null $viewClass null )
Создаёт экземпляр класса представления на основе текущей конфигурации.
Параметры
- string|null
$viewClassнеобязательно null - Необязательное имя класса представления с пространством имён для создания экземпляра.
Возвращает
Cake\View\ViewИсключения
Cake\View\Exception\MissingViewExceptionЕсли класс представления не был найден.
set()source public
set( string|array $name , mixed $value null )
Сохраняет переменную или ассоциативный массив переменных для использования внутри шаблона.
Параметры
- string|array
$name - Строка или массив данных.
- mixed
$valueнеобязательно 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
$optionsнеобязательно null - строка или массив строк, которые нужно добавить в _validViewOptions.
- boolean
$mergeнеобязательно true Следует ли слить или переопределить существующие допустимые параметры представления. По умолчанию
true.
Возвращает
arrayОбновлённые параметры представления в виде массива.
Магические методы, унаследованные от Cake\Event\EventDispatcherInterface
getEventManager() |
Подробности свойств
© 2005–2017 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.4/class-Cake.View.AjaxView.html