Spec-Zone.ru › CakePHP 3.1

Класс AssetFilter

Фильтрует запрос и проверяет, является ли он файлом в папке webroot, и отправляет файл клиенту, если это необходимо.

Cake\Routing\DispatcherFilter implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait
Extended by Cake\Routing\Filter\AssetFilter
Пространство имён: Cake\Routing\Filter
Расположение: Routing/Filter/AssetFilter.php

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

__constructsource public

__construct( array $config [] )

Конструктор.

Параметры

массив $config необязательно []
Массив конфигурации.

Исключения

InvalidArgumentException
Когда условия 'when' не вызываемый метод.

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

Cake\Routing\DispatcherFilter::__construct()

_deliverAssetsource protected

_deliverAsset( Cake\Network\Request $request , Cake\Network\Response $response , string $assetFile , string $ext )

Отправляет файл ресурса клиенту

Параметры

Cake\Network\Request $request
Объект запроса для использования.
Cake\Network\Response $response
Объект ответа для использования.
строка $assetFile
Путь к файлу ресурса в файловой системе
строка $ext
Расширение файла для определения типа MIME

_getAssetFilesource protected

_getAssetFile( string $url )

Строит путь к файлу ресурса на основе URL

Параметры

строка $url
URL ресурса

Возвращает

string
Абсолютный путь к файлу ресурса

beforeDispatchsource public

beforeDispatch( Cake\Event\Event $event )

Проверяет, существует ли запрашиваемый ресурс, и отправляет его в браузер

Параметры

Cake\Event\Event $event
содержащий объекты запроса и ответа

Возвращает

Cake\Network\Response
если клиент запрашивает распознанный ресурс, иначе null

Исключения

Cake\Network\Exception\NotFoundException
Когда ресурс не найден

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

Cake\Routing\DispatcherFilter::beforeDispatch()

Наследуемые методы из Cake\Routing\DispatcherFilter

afterDispatchsource public

afterDispatch( Cake\Event\Event $event )

Метод, вызываемый после того, как контроллер обработает запрос и сгенерирует ответ. В этот момент можно изменить объект ответа, так как он еще не отправлен клиенту.

Если возвращается false, событие будет остановлено, и больше никаких слушателей не будут уведомлены. В качестве альтернативы можно вызвать $event->stopPropagation() для достижения такого же результата.

Параметры

Cake\Event\Event $event
объект контейнера, имеющий request и response ключи в свойстве data.

handlesource public

handle( Cake\Event\Event $event )

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

Параметры

Cake\Event\Event $event
экземпляр события.

Возвращает

mixed
смешанный тип

implementedEventssource public

implementedEvents( )

Возвращает список событий, на которые этот фильтр подписывается. Диспечер уведомляет о 2 различных событиях Dispatcher.before и Dispatcher.after. По умолчанию этот класс подключит метод preDispatch и postDispatch соответственно.

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

Возвращает

array
массив

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

matchessource public

matches( Cake\Event\Event $event )

Проверяет, соответствует ли входящий запрос критериям этого фильтра.

Параметры

Cake\Event\Event $event
Событие для сопоставления.

Возвращает

boolean
логическое значение

Методы, используемые из Cake\Core\InstanceConfigTrait

_configDeletesource protected

_configDelete( string $key )

Удаляет один ключ конфигурации

Параметры

строка $key
Ключ для удаления.

Исключения

Cake\Core\Exception\Exception
если попытка перезаписать существующую конфигурацию

_configReadsource protected

_configRead( string|null $key )

Считывает переменную конфигурации

Параметры

строка|null $key
Ключ для чтения.

Возвращает

mixed
смешанный тип

_configWritesource protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Записывает переменную конфигурации

Параметры

строка|массив $key
Ключ для записи.
смешанный тип $value
Значение для записи.
логическое значение|строка $merge необязательно false
True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключения

Cake\Core\Exception\Exception
если попытка перезаписи существующей конфигурации

configsource public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Использование

Чтение всей конфигурации:

$this->config();

Чтение определенного значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

строка|массив|null $key необязательно null
Ключ для получения/установки или полный массив конфигураций.
смешанный тип|null $value необязательно null
Значение для установки.
логическое значение $merge необязательно true
Флаг рекурсивного слияния или перезаписи существующей конфигурации, по умолчанию true.

Возвращает

mixed
Значение конфигурации, которое читается, или сам объект при операциях записи.

Исключения

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

configShallowsource public

configShallow( string|array $key , mixed|null $value null )

Объединяет предоставленную конфигурацию с существующей. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

строка|массив $key
Ключ для установки или полный массив конфигураций.
смешанный тип|null $value необязательно null
Значение для установки.

Возвращает

mixed
Сам объект $this.

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

$_cacheTimesource

protected string

Время кеширования актива.

'+1 day'

$_prioritysource

protected integer

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

9

Свойства, унаследованные от Cake\Routing\DispatcherFilter

$_defaultConfigsource

protected array

Умолчательные настройки.

Эти настройки объединяются с предоставленными пользователем настройками при использовании класса. Опции when и for позволяют определять условия, проверяемые перед вызовом вашего фильтра.

[
    'when' => null,
    'for' => null,
    'priority' => null,
]

Свойства, используемые из Cake\Core\InstanceConfigTrait

$_configsource

protected array

Настройки во время выполнения.

[]

$_configInitializedsource

protected boolean

Указатель того, была ли свойство config уже настроена с умолчаниями.

false

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.Routing.Filter.AssetFilter.html

Spec-Zone.ru

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