Класс SerializedView

__construct()source 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()

loadHelpers()source public

loadHelpers( )

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

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

Cake\View\View::loadHelpers()

render()source public

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

Отображение шаблона представления или возврат сериализованных данных.

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

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

Параметры

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

Представление, которое отображается.

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

Макет, который отображается.

Возвращает

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

Исключения

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

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

Cake\View\View::render()

__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

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

Возвращает

строка
Отображаемый результат

_getElementFileName()source protected

_getElementFileName( string $name , boolean $pluginCheck true )

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

Параметры

строка $name

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

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

Параметры

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

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

Возвращает

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

Выбрасывает

Cake\View\Exception\MissingTemplateException
в случае, если файл шаблона не найден.

_inflectViewFileName()source protected

_inflectViewFileName( string $name )

Изменяет имя файла шаблона представления в нижний регистр с разделителем «_».

Параметры

string $name

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

Возвращает

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

_paths()source protected

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

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

Параметры

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

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

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

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

Возвращает

array
Пути

_render()source protected

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

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

Параметры

string $viewFile

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

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

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

Возвращает

string
Вывод после рендеринга

Выбрасывает

LogicException
Когда блок не закрыт.

Вызывает

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

_renderElement()source protected

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

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

Параметры

string $file

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

array $data

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

array $options

Опции элемента

Возвращает

string

Вызывает

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

append()source public

append( string $name , mixed $value null )

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

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

Параметры

string $name

Имя блока

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

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

См. также

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

Параметры

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, чтобы вызывать обработчики 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
Успех

end()source public

end( )

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

См. также

\Cake\View\ViewBlock::end()

exists()source public

exists( string $name )

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

Параметры

string $name

Имя блока

Возвращает

boolean

extend()source public

extend( string $name )

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

Параметры

string $name

Шаблон или элемент, с которым нужно расширить текущий.

Исключения

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

fetch()source public

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

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

Параметры

string $name

Имя блока

string $default необязательно ''

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

Возвращает

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

См. также

\Cake\View\ViewBlock::get()

get()source public

get( string $var , mixed $default null )

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

Параметры

string $var

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

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

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

Возвращает

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

getCurrentType()source public

getCurrentType( )

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

Возвращает

string

getVars()source public

getVars( )

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

Возвращает

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

helpers()source public

helpers( )

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

Возвращает

Cake\View\HelperRegistry

initialize()source public

initialize( )

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

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

layout()source public

layout( string|null $name null )

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

Параметры

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

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

Возвращает

string|null

layoutPath()source public

layoutPath( string|null $path null )

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

Параметры

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

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

Возвращает

string|null

loadHelper()source public

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

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

Параметры

string $name

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

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

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

Возвращает

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

См. также

\Cake\View\HelperRegistry::load()

pluginSplit()source public

pluginSplit( string $name , boolean $fallback true )

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

Параметры

string $name

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

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

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

Возвращает

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

prepend()source public

prepend( string $name , mixed $value )

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

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

Параметры

string $name

Имя блока

mixed $value

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

См. также

\Cake\View\ViewBlock::concat()

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

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/<подпапка> без расширения .ctp.

Параметры

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

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

Возвращает

string|null

templatePath()source public

templatePath( string|null $path null )

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

Параметры

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

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

Возвращает

string|null

theme()source public

theme( string|null $theme null )

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

Параметры

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

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

Возвращает

string|null

uuid()source public

uuid( string $object , string $url )

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

Параметры

строка $object

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

строка $url

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

Возвращает

строка

_createCell()source protected

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

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

Параметры

строка $className

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

строка $action

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

строка $plugin

Имя плагина.

массив $options

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

Возвращает

Cake\View\Cell;

cell()source 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
Если класс ячейки не указал действие ячейки.

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 для этого объекта.

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

Параметры

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

установленный eventManager

Возвращает

Cake\Event\EventManager

log()source public

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

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

Параметры

смешанное $msg

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

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

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

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

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

Возвращает

логическое значение
Успех записи в журнал.

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'.

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.

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

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

Возвращает

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