Класс SerializedView

__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

Экземпляр EventManager.

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

Массив параметров представления

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

Cake\View\View::__construct()

loadHelperssource public

loadHelpers( )

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

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

Cake\View\View::loadHelpers()

rendersource public

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

Выполнить отображение шаблона представления или вернуть сериализованные данные.

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

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

Параметры

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

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

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

Отображаемый макет.

Возвращает

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

Выбрасывает

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

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

Cake\View\View::render()

__getsource public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

mixed
mixed

__setsource public

__set( string $name , mixed $value )

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

Параметры

строка $name

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

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

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

Параметры

string|null $plugin необязательно null

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

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

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

Возвращает

array
пути

_rendersource protected

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

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

Параметры

string $viewFile

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

array $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 для него и записывает в кеш, если используется кеширование.

Параметры

string $file

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

array $data

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

array $options

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

Возвращает

string
строка

Вызывает

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

appendsource public

append( string $name , mixed $value null )

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

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

Параметры

string $name

Имя блока

mixed $value необязательно null

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

См. также

Cake\View\ViewBlock::concat()

assignsource public

assign( string $name , mixed $value )

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

Параметры

string $name

Имя блока

mixed $value

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

См. также

Cake\View\ViewBlock::set()

autoLayoutsource public

autoLayout( boolean $autoLayout null )

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

Параметры

boolean $autoLayout необязательно null

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

Возвращает

boolean|null
bool|null

blockssource public

blocks( )

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

Возвращает

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

См. также

Cake\View\ViewBlock::keys()

cachesource public

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

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

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

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

Параметры

callable $block

Блок кода, вывод которого необходимо кэшировать.

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

Параметры, определяющие ключ кеша и т. д.

Возвращает

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

Выбрасывает

RuntimeException
Если в $options отсутствует параметр 'key'.

elementsource 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, чтобы не генерировать исключения.

Возвращает

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

Выбрасывает

Cake\View\Exception\MissingElementException
Если элемент отсутствует и ignoreMissing равно false.

elementExistssource public

elementExists( string $name )

Проверяет наличие элемента.

Параметры

string $name

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

Возвращает

boolean
Успех

endsource public

end( )

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

См. также

Cake\View\ViewBlock::end()

existssource public

exists( string $name )

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

Параметры

string $name

Имя блока

Возвращает

boolean
bool

extendsource public

extend( string $name )

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

Параметры

string $name

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

Выбрасывает

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

fetchsource public

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

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

Параметры

string $name

Имя блока

string $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.

Параметры

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

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

Возвращает

string|null
строка|null

layoutPathsource public

layoutPath( string $path null )

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

Параметры

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

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

Возвращает

string|null
строка|null

loadHelpersource public

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

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

Параметры

строка $name

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

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

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

Возвращает

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

См. также

Cake\Core\ObjectRegistry::load()

pluginSplitsource public

pluginSplit( string $name , boolean $fallback true )

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

Параметры

строка $name

Имя плагина, который необходимо разделить.

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

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

Возвращает

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

prependsource public

prepend( string $name , mixed $value )

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

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

Параметры

строка $name

Имя блока

смешанный $value

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

См. также

Cake\View\ViewBlock::concat()

renderLayoutsource public

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

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

Параметры

строка $content

Содержимое для рендеринга в шаблоне, обернутое окружающим макетом.

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

Имя макета

Возвращает

mixed
Результат рендеринга или false при ошибке

Исключения

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

Вызывает

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

resetsource public

reset( string $name )

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

Параметры

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

Параметры

строка $name

Имя блока, для которого нужно захватить вывод.

См. также

Cake\View\ViewBlock::start()

templatesource public

template( string $name null )

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

Параметры

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

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

Возвращает

string|null
строка|null

templatePathsource public

templatePath( string $path null )

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

Параметры

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

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

Возвращает

string|null
строка|null

themesource public

theme( string $theme null )

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

Параметры

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

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

Возвращает

string|null
строка|null

uuidsource public

uuid( string $object , string $url )

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

Параметры

строка $object

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

строка $url

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

Возвращает

string
строка

_createCellsource protected

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

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

Параметры

string $className

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

string $action

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

string $plugin

Имя плагина.

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

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

Параметры

string $cell

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

array $data optional []

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

array $options optional []

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

Возвращает

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

Выбрасывает

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

dispatchEventsource public

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

Оборачивающий метод для создания и отправки событий.

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

Параметры

string $name

Имя события.

array|null $data optional null

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

object|null $subject optional 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 optional 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().

Параметры

mixed $msg

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

integer|string $level optional LogLevel::ERROR

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

string|array $context optional []

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

Возвращает

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

$vars = $this->requestAction('/articles/popular', [
  'environment' => ['CONTENT_TYPE' => 'application/json']
]);

Передача сессии

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

$vars = $this->requestAction('/articles/popular', [
  'session' => new Session($someSessionConfig)
]);

Параметры

string|array $url

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

array $extra optional []

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

Возвращает

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

createViewsource public

createView( string|null $viewClass null )

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

Параметры

string|null $viewClass optional null

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

Возвращает

Cake\View\View
\Cake\View\View

Выбрасывает

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

setsource public

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

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

Параметры

string|array $name

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

string|array|null|boolean $value optional 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().

Параметры

string|array|null $options optional null

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

boolean $merge optional true

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

Возвращает

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

null

''

'.ctp'

[]

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

[]

[]

[]

true

'default'

false

[]

'default'

null

null

[]

null

null

null

null

null

[]

'\Cake\Event\Event'

null

null

[]