Класс AjaxView

__constructsource public

__construct( Cake\Network\Request $request null , Cake\Network\Response $response null , Cake\Event\EventManager $eventManager null , array $viewOptions [] )

Конструктор

Параметры

Cake\Network\Request $request необязательно null

Объект запроса.

Cake\Network\Response $response необязательно null

Объект ответа.

Cake\Event\EventManager $eventManager необязательно null

Объект менеджера событий.

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

Параметры представления.

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

Cake\View\View::__construct()

__getsource public

__get( string $name )

Магический метод доступа к помощникам.

Параметры

строка $name

Имя атрибута для получения.

Возвращает

mixed
смешанное значение

__setsource public

__set( string $name , mixed $value )

Магический метод установки устаревших свойств.

Параметры

строка $name

Имя свойства.

смешанное значение $value

Значение свойства.

_checkFilePathsource protected

_checkFilePath( string $file , string $path )

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

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

Параметры

строка $file

Путь к файлу шаблона.

строка $path

Базовый путь, в котором должен находиться $file.

Возвращает

string
Путь к файлу

Исключение

InvalidArgumentException
\InvalidArgumentException

_elementCachesource protected

_elementCache( string $name , array $data , array $options )

Генерирует конфигурацию кэша для элемента.

Параметры

строка $name

Имя элемента

массив $data

Данные

массив $options

Параметры элемента

Возвращает

array
Конфигурация кэша элементов.

_evaluatesource protected

_evaluate( string $viewFile , array $dataForView )

Метод, который обрабатывает шаблон/скрипт представления.

Параметры

строка $viewFile

Имя файла представления

массив $dataForView

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

Возвращает

string
Результат рендера

_getElementFileNamesource protected

_getElementFileName( string $name )

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

Параметры

строка $name

Имя элемента для поиска.

Возвращает

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

_getLayoutFileNamesource protected

_getLayoutFileName( string|null $name null )

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

Параметры

строка|null $name необязательно null

Имя шаблона для поиска.

Возвращает

string
Имя файла шаблона (.ctp).

Исключение

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

_getSubPathssource protected

_getSubPaths( string $basePath )

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

Параметры

строка $basePath

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

Возвращает

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

_getViewFileNamesource protected

_getViewFileName( string|null $name null )

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

Параметры

строка|null $name необязательно null

Действие контроллера для поиска имени файла шаблона

Возвращает

string
Имя файла шаблона

Исключение

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

_inflectViewFileNamesource protected

_inflectViewFileName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_pathssource protected

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

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

Параметры

строка|null $plugin необязательно null

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

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

Установите в false, чтобы принудительно обновить пути представлений. По умолчанию true.

Возвращает

array
Пути

_rendersource protected

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

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

Параметры

строка $viewFile

Имя файла представления

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

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

Возвращает

string
Результат рендера

Исключение

LogicException
При открытом блоке.

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

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

_renderElementsource protected

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

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

Параметры

строка $file

Путь к файлу элемента

массив $data

Данные для отображения

массив $options

Параметры элемента

Возвращает

string
строка

Вызывает

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

appendsource public

append( string $name , mixed $value null )

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

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

Параметры

строка $name

Имя блока

смешанный $value необязательно null

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

См. также

Cake\View\ViewBlock::concat()

assignsource public

assign( string $name , mixed $value )

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

Параметры

строка $name

Имя блока

смешанный $value

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

См. также

Cake\View\ViewBlock::set()

autoLayoutsource public

autoLayout( boolean $autoLayout null )

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

Параметры

логическое значение $autoLayout необязательно null

Логическое значение для включения/выключения. Если null, возвращает текущее значение.

Возвращает

boolean|null
bool|null

blockssource public

blocks( )

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

Возвращает

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

См. также

Cake\View\ViewBlock::keys()

cachesource public

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

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

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

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

Параметры

вызываемая функция $block

Блок кода, результат которого нужно кэшировать.

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

Опции, определяющие ключ кэша и т. д.

Возвращает

string
Содержимое результата рендеринга.

Выбрасывает

RuntimeException
Когда в $options отсутствует опция 'key'.

elementsource public

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

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

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

Параметры

строка $name

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

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

Массив данных, которые будут доступны рендеренному представлению (то есть элементу).

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

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

Возвращает

string
Рендеренный элемент

Выбрасывает

Cake\View\Exception\MissingElementException
Когда элемент отсутствует, а ignoreMissing - false.

elementExistssource public

elementExists( string $name )

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

Параметры

строка $name

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

Возвращает

boolean
Успех

endsource public

end( )

Завершить захват блока. Соответствие View::start()

См. также

Cake\View\ViewBlock::end()

existssource public

exists( string $name )

Проверить наличие блока.

Параметры

строка $name

Имя блока

Возвращает

boolean
bool

extendsource public

extend( string $name )

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

Параметры

строка $name

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

Выбрасывает

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

fetchsource public

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

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

Параметры

строка $name

Имя блока

строка $default необязательно ''

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

Возвращает

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

См. также

Cake\View\ViewBlock::get()

getsource public

get( string $var , mixed $default null )

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

Параметры

строка $var

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

смешанный $default необязательно null

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

Возвращает

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

getCurrentTypesource public

getCurrentType( )

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

Возвращает

string
строка

getVarssource public

getVars( )

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

Возвращает

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

helperssource public

helpers( )

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

Возвращает

Cake\View\HelperRegistry
\Cake\View\HelperRegistry

initializesource public

initialize( )

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

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

layoutsource public

layout( string $name null )

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

Параметры

string $name необязательный null

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

Возвращает

string|null
string|null

layoutPathsource public

layoutPath( string $path null )

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

Параметры

string $path необязательный null

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

Возвращает

string|null
string|null

loadHelpersource public

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

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

Параметры

string $name

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

array $config необязательный []

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

Возвращает

Cake\View\Helper
Объект помощника.

См.

Cake\Core\ObjectRegistry::load()

loadHelperssource public

loadHelpers( )

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

pluginSplitsource public

pluginSplit( string $name , boolean $fallback true )

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

Параметры

string $name

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

boolean $fallback необязательный true

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

Возвращает

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

prependsource public

prepend( string $name , mixed $value )

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

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

Параметры

string $name

Имя блока

mixed $value

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

См.

Cake\View\ViewBlock::concat()

rendersource public

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

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

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

• beforeRender
• afterRender
• beforeLayout
• afterLayout

Если View::$autoRender равен false и не задан $layout, шаблон будет возвращён без обработки.

Имена шаблонов и макетов могут указывать на шаблоны/макеты плагинов. Используя синтаксис Plugin.template, можно использовать шаблон/макет плагина вместо прикладных. Если выбранный плагин не найден, шаблон будет найден в стандартном порядке.

Параметры

string|null $view необязательный null

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

string|null $layout необязательный null

Используемый макет.

Возвращает

string|null
Сгенерированное содержимое или null, если содержимое уже было обработано и возвращено ранее.

Выбрасывает

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

Вызывает

View.beforeRender $this, [$viewFileName]
View.afterRender $this, [$viewFileName]

renderLayoutsource 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]

resetsource public

reset( string $name )

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

Параметры

string $name

Имя блока

См.

Cake\View\ViewBlock::set()

startsource public

start( string $name )

Начать захват вывода для «блока»

Вы можете использовать start несколько раз для блока, чтобы добавить или вставить содержимое в режиме захвата.

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

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

Параметры

string $name

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

См.

Cake\View\ViewBlock::start()

templatesource public

template( string $name null )

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

Параметры

string $name необязательный null

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

Возвращает

string|null
string|null

templatePathsource public

templatePath( string $path null )

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

Параметры

string $path необязательный null

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

Возвращает

string|null
string|null

themesource public

theme( string $theme null )

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

Параметры

string $theme необязательный null

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

Возвращает

string|null
string|null

uuidsource public

uuid( string $object , string $url )

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

Параметры

string $object

Тип объекта, например «форма» или «ссылка»

string $url

Целевой URL объекта.

Возвращает

string
string

_createCellsource protected

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

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

Параметры

строка $className

Имя класса ячейки.

строка $action

Имя действия.

строка $plugin

Имя плагина.

массив $options

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

Возвращает

Cake\View\Cell;
\Cake\View\Cell;

cellsource public

cell( string $cell , array $data [] , array $options [] )

Отображает заданную ячейку.

Пример:

// Taxonomy\View\Cell\TagCloudCell::smallList()
$cell = $this->cell('Taxonomy.TagCloud::smallList', ['limit' => 10]);

// App\View\Cell\TagCloudCell::smallList()
$cell = $this->cell('TagCloud::smallList', ['limit' => 10]);

Действие display будет использоваться по умолчанию, если действие не указано:

// Taxonomy\View\Cell\TagCloudCell::display()
$cell = $this->cell('Taxonomy.TagCloud');

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

Параметры

строка $cell

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

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

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

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

Параметры конструктора ячейки.

Возвращает

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

Выбрасывает

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

dispatchEventsource public

dispatchEvent( string $name , array|null $data null , object|null $subject null )

Обёртка для создания и отправки событий.

Возвращает обработанное событие.

Параметры

строка $name

Имя события.

массив|null $data необязательно null

Любое значение, которое вы хотите передать вместе с этим событием, чтобы его могли прочитать слушатели.

объект|null $subject необязательно null

Объект, к которому относится это событие (по умолчанию $this).

Возвращает

Cake\Event\Event
\Cake\Event\Event

Реализация

Cake\Event\EventDispatcherInterface::dispatchEvent()

eventManagersource public

eventManager( Cake\Event\EventManager $eventManager null )

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

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

Параметры

Cake\Event\EventManager $eventManager необязательно null

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

Возвращает

Cake\Event\EventManager
\Cake\Event\EventManager

Реализация

Cake\Event\EventDispatcherInterface::eventManager()

logsource public

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

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

Параметры

смешанный $msg

Сообщение журнала.

целое число|строка $level необязательно LogLevel::ERROR

Уровень ошибки.

строка|массив $context необязательно []

Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

boolean
Успех записи в журнал.

requestActionsource public

requestAction( string|array $url , array $extra [] )

Вызывает метод контроллера из любого места. Может использоваться для связи контроллеров друг с другом или для подключения плагинов к основному приложению. requestAction может использоваться для возвращения рендеренных представлений или получения возвращаемого значения действий контроллера.

Под капотом этот метод использует Router::reverse() для преобразования параметра $url в строковый URL. Вы должны использовать форматы URL, совместимые с Router::reverse().

Примеры

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

$variables = $this->requestAction('/articles/popular');

Простой пример 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)
]);

Параметры

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

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

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

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

Возвращает

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

createViewsource public

createView( string|null $viewClass null )

Создаёт экземпляр класса представления на основе текущей конфигурации.

Параметры

строка|null $viewClass необязательно null

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

Возвращает

Cake\View\View
\Cake\View\View

Выбрасывает

Cake\View\Exception\MissingViewException
Если класс представления не найден.

setsource public

set( string|array $name , string|array|null|boolean $value null )

Сохраняет переменную или ассоциативный массив переменных для использования внутри шаблона.

Параметры

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

Строка или массив данных.

строка|массив|null|boolean $value необязательно null

Значение в случае, если $name является строкой (которая затем используется в качестве ключа). Не используется, если $name является ассоциативным массивом, в противном случае служит значениями для ключей $name.

Возвращает

mixed
$this

viewBuildersource public

viewBuilder( )

Получить используемого билдера представлений.

Возвращает

Cake\View\ViewBuilder
\Cake\View\ViewBuilder

viewOptionssource public

viewOptions( string|array|null $options null , boolean $merge true )

Получение/Установка допустимых параметров представления в свойстве объекта _validViewOptions. Свойство создаётся как пустой массив, если оно не задано. Если вызывается без параметров, возвращает текущий список допустимых параметров представления. См. createView().

Параметры

строка|массив|null $options необязательно null

строка или массив строк, которые необходимо добавить в _validViewOptions.

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

Объединить или переопределить существующие допустимые параметры представления. По умолчанию true.

Возвращает

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

'ajax'

null

''

'.ctp'

[]

[
    'viewVars', 'autoLayout', 'helpers', 'template', 'layout', 'name', 'theme',
    'layoutPath', 'templatePath', 'plugin', 'passedArgs'
]

[]

[]

[]

true

'default'

false

[]

null

null

[]

null

null

null

null

null

[]

'\Cake\Event\Event'

null

null

[]