Spec-Zone.ru › CakePHP 3.6

Класс 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
Extended by Cake\View\AjaxView
Пространство имён: Cake\View
Расположение: View/AjaxView.php

Наследуемые константы

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

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

  • $layout public
    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, 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.

Возвращает

строка
Путь к файлу

Выбрасывает

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, если файл не найден.

_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) в виде строки. Имена действий с использованием верхнего регистра будут преобразовываться в нижний регистр с подчёркиваниями по умолчанию. Это означает, что у вас могут быть имена действий со сложным написанием, которые ссылаются на представления long_action_names.ctp. Вы можете изменить правило склонения, переопределив _inflectViewFileName.

Параметры

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

Возвращает

строка
Имя файла шаблона

Выбрасывает

Cake\View\Exception\MissingTemplateException
если файл представления не найден.

_inflectViewFileName()source protected

_inflectViewFileName( string $name )

Изменение имени файла шаблона представления в формате с подчёркиваниями.

Параметры

строка $name
Имя файла, которое необходимо преобразовать.

Возвращает

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

_paths()source protected

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

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

Параметры

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

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

Параметры

string $name

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

Возвращает

boolean
Успех

enableAutoLayout()source public

enableAutoLayout( boolean $enable = true )

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

Параметры

boolean $enable необязательно true
Булево значение для включения/выключения.

Возвращает


$this

end()source public

end( )

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

Возвращает


$this

См. также

\Cake\View\ViewBlock::end()

exists()source public

exists( string $name )

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

Параметры

string $name
Имя блока

Возвращает

boolean

extend()source public

extend( string $name )

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

Параметры

string $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
Значение по умолчанию/fallback для $var.

Возвращает

смешанный
Содержимое переменной, если она задана, иначе $default.

getCurrentType()source public

getCurrentType( )

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

Возвращает

строка

getLayout()source public

getLayout( )

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

Возвращает

строка

getLayoutPath()source public

getLayoutPath( )

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

Возвращает

строка

getTemplate()source public

getTemplate( )

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

Возвращает

строка

getTemplatePath()source public

getTemplatePath( )

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

Возвращает

строка

getTheme()source public

getTheme( )

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

Возвращает

строка|null

getVars()source public

getVars( )

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

Возвращает

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

helpers()source public

helpers( )

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

Возвращает

Cake\View\HelperRegistry

initialize()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, возвращает текущее имя.

Возвращает

строка|null

layoutPath()source public устарело

layoutPath( string|null $path = null )

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

Устарело

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

Параметры

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

Возвращает

строка|null

loadHelper()source public

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

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

Параметры

строка $name
Имя помощника для загрузки.
массив $config необязательно []
Настройки для помощника

Возвращает

Cake\View\Helper
Созданный объект помощника.

См. также

\Cake\View\HelperRegistry::load()

loadHelpers()source public

loadHelpers( )

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

Возвращает


$this

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

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

Возвращает


$this

См. также

\Cake\View\ViewBlock::concat()

render()source public

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

Отображает представление для заданного файла шаблона и макета.

Отображение вызывает обратные вызовы помощников, которые срабатывают до и после рендеринга шаблона, а также до и после рендеринга макета. Обратные вызовы помощников вызываются:

  • beforeRender
  • afterRender
  • beforeLayout
  • afterLayout

Если 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
Имя блока

Возвращает


$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
устанавливаемый eventManager

Возвращает

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
устанавливаемый 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 Вы должны переработать свой код, чтобы использовать ячейки представлений вместо этого метода.

Параметры

строка|массив $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()

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

$layoutsource

public строка

'ajax'

© 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.AjaxView.html

Spec-Zone.ru

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