Класс AjaxView

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

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

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

Возвращает

$this

См. также

\Cake\View\ViewBlock::concat()

assign()source public

assign( string $name , mixed $value )

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

Параметры

string $name

Имя блока

mixed $value

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

Возвращает

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

disableAutoLayout()source public

disableAutoLayout( )

Отключает стандартный режим CakePHP для применения файлов макета.

Макеты не будут автоматически применяться к рендеренным представлениям.

Возвращает

$this

element()source public

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

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

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

Параметры

string $name

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

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

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

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

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

Возвращает

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

Исключения

Cake\View\Exception\MissingElementException

Когда элемент отсутствует, и ignoreMissing равно false.

elementExists()source public

elementExists( string $name )

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

Параметры

string $name

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

Возвращает

boolean
Успех

enableAutoLayout()source public

enableAutoLayout( boolean $enable = true )

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

Параметры

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

Булево значение для включения/выключения.

Возвращает

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

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

Параметры

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

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

Возвращает

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

getCurrentType()source public

getCurrentType( )

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

Возвращает

строка

getLayout()source public

getLayout( )

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

Возвращает

строка

getLayoutPath()source public

getLayoutPath( )

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

Возвращает

строка

getName()source public

getName( )

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

Возвращает

строка|null

С момента

3.7.7

getPlugin()source public

getPlugin( )

Возвращает имя плагина.

Возвращает

строка|null

С момента

3.7.0

getRequest()source public

getRequest( )

Получение экземпляра запроса.

Возвращает

Cake\Http\ServerRequest

С момента

3.7.0

getResponse()source public

getResponse( )

Получение экземпляра ответа.

Возвращает

Cake\Http\Response

С момента

3.7.0

getSubDir()source public

getSubDir( )

Получение подкаталога для файлов шаблонов.

Возвращает

строка

См. также

\Cake\View\View::$subDir

С момента

3.7.0

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 )

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

Render вызывает колбэки хелперов, которые срабатывают до и после отображения шаблона, а также до и после макета. Колбэки хелперов вызываются:

• beforeRender
• afterRender
• beforeLayout
• afterLayout

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

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

Параметры

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

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

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

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

Возвращает

строка|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 при ошибке. Для использования в макете создаются несколько переменных.

Параметры

строка $content

Содержимое, которое нужно отобразить в шаблоне, заключённое в окружающий макет.

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

Имя макета

Возвращает

смешанное
Отображенный вывод или false при ошибке

Выбрасывает

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

Вызывает

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

reset()source public

reset( string $name )

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

Параметры

строка $name

Имя блока

Возвращает

$this

См. также

\Cake\View\ViewBlock::set()

setElementCache()source public

setElementCache( string $elementCache )

Устанавливает конфигурацию кеша, которую будет использовать View для хранения кэшированных элементов

Параметры

строка $elementCache

Имя конфигурации кеша.

Возвращает

$this

См. также

\Cake\View\View::$elementCache

С тех пор как

3.7.0

setLayout()source public

setLayout( string $name )

Установить имя файла макета, в котором нужно отобразить шаблон. Указанное имя - это имя файла макета в /src/Template/Layout без расширения .ctp.

Параметры

строка $name

Имя файла макета для установки.

Возвращает

$this

setLayoutPath()source public

setLayoutPath( string $path )

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

Параметры

строка $path

Путь к файлам макета.

Возвращает

$this

setPlugin()source public

setPlugin( string $name )

Устанавливает имя плагина.

Параметры

строка $name

Имя плагина.

Возвращает

$this

С тех пор как

3.7.0

setRequest()source public

setRequest( Cake\Http\ServerRequest $request )

Устанавливает объекты запроса и настраивает ряд свойств контроллера на основе содержимого запроса. Устанавливаемые свойства:

• $this->request - В $request параметр
• $this->plugin - В значение, возвращённое $request->getParam('plugin')
• $this->passedArgs - Аналогично $request->params['pass]

Параметры

Cake\Http\ServerRequest $request

Экземпляр запроса.

Возвращает

$this

С тех пор как

3.7.0

setResponse()source public

setResponse( Cake\Http\Response $response )

Устанавливает экземпляр ответа.

Параметры

Cake\Http\Response $response

Экземпляр ответа.

Возвращает

$this

С тех пор как

3.7.0

setSubDir()source public

setSubDir( string $subDir )

Установить поддиректорию для файлов шаблонов.

Параметры

строка $subDir

Имя поддиректории.

Возвращает

$this

См. также

\Cake\View\View::$subDir

С тех пор как

3.7.0

setTemplate()source public

setTemplate( string $name )

Установить имя файла шаблона для отображения. Указанное имя - это имя файла в /src/Template/ без расширения .ctp.

Параметры

строка $name

Имя файла шаблона для установки.

Возвращает

$this

setTemplatePath()source public

setTemplatePath( string $path )

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

Параметры

строка $path

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

Возвращает

$this

setTheme()source public

setTheme( string|null $theme )

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

Параметры

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

Параметры

строка $name

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

Возвращает

$this

См. также

\Cake\View\ViewBlock::start()

template()source public deprecated

template( string|null $name = null )

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

Устарело

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

Параметры

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

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

Возвращает

string|null

templatePath()source public deprecated

templatePath( string|null $path = null )

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

Устарело

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

Параметры

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

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

Возвращает

string|null

theme()source public deprecated

theme( string|null $theme = null )

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

Устарело

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

Параметры

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

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

Возвращает

string|null

uuid()source public deprecated

uuid( string $object , string $url )

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

Устарело

3.7.0 Этот метод устарел и будет удалён в версии 4.0.0.

Параметры

string $object

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

string $url

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

Возвращает

string

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

dispatchEvent()source public

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

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

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

Параметры

string $name

Имя события.

array|null $data необязательно null

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

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

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

Возвращает

Cake\Event\Event

eventManager()source public deprecated

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

log()source public

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

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

Параметры

mixed $msg

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

integer|string $level необязательно LogLevel::ERROR

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

string|array $context необязательно []

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

Возвращает

boolean
Результат записи в журнал.

requestAction()source public deprecated

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 Необходимо переписать ваш код для использования View Cells вместо этого метода.

Параметры

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

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

Возвращает

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 deprecated

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

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

Устаревшее

3.7.0 Используйте ViewBuilder::setOptions() или любой из его методов set метода вместо этого.

Параметры

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

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

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

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

Возвращает

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

'ajax'