Класс AssetFilter
Фильтрует запрос и проверяет, является ли он файлом в папке webroot, и если это соответствует требованиям, отправляет файл клиенту.
- Cake\Routing\DispatcherFilter реализует Cake\Event\EventListenerInterface использует Cake\Core\InstanceConfigTrait
-
Cake\Routing\Filter\AssetFilter
Краткое описание свойств
-
$_cacheTimeprotectedВремя кэширования актива.string -
$_priorityprotectedintegerПриоритет по умолчанию для всех методов в этом фильтре. Этот фильтр должен выполняться до того, как запрос будет обработан маршрутизатором.
Наследованные свойства
Краткое описание методов
- __construct() public
- _deliverAsset() protectedОтправляет файл актива клиенту
- _getAssetFile() protectedСтроит путь к файлу актива на основе URL
- beforeDispatch() publicПроверяет наличие запрошенного актива и отправляет его в браузер
Подробное описание методов
__construct()source public
__construct( array $config [] )
Конструктор.
Параметры
- массив
$configнеобязательно [] - Массив конфигурации.
Исключения
InvalidArgumentExceptionКогда условия 'when' не являются вызываемыми функциями.
Переопределяет
Cake\Routing\DispatcherFilter::__construct() _deliverAsset()source 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
_getAssetFile()source protected
_getAssetFile( string $url )
Строит путь к файлу актива на основе URL
Параметры
- строка
$url - URL актива
Возвращает
строкаАбсолютный путь к файлу актива
beforeDispatch()source 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
afterDispatch()source public
afterDispatch( Cake\Event\Event $event )
Метод, вызываемый после того, как контроллер обработал запрос и сгенерировал ответ. В этот момент можно изменить объект ответа, так как он еще не отправлен клиенту.
Если возвращено значение false, событие будет остановлено, и больше никаких слушателей уведомляться не будут. В качестве альтернативы вы можете вызвать $event->stopPropagation() для достижения того же результата.
Параметры
-
Cake\Event\Event$event объект контейнера, содержащий ключи
requestиresponseв свойстве data.
handle()source public
handle( Cake\Event\Event $event )
Метод обработки, который применяет условия и определяет правильный метод вызова.
Параметры
-
Cake\Event\Event$event - Объект события.
Возвращает
смешанноеimplementedEvents()source public
implementedEvents( )
Возвращает список событий, на которые этот фильтр реагирует. Диспечер уведомляет о двух разных событиях Dispatcher.before и Dispatcher.after. По умолчанию этот класс подключит методы preDispatch и postDispatch соответственно.
Переопределите этот метод по своему усмотрению, чтобы реагировать только на интересующие вас события.
Возвращает
массивРеализация
Cake\Event\EventListenerInterface::implementedEvents() matches()source public
matches( Cake\Event\Event $event )
Проверяет, соответствует ли входящий запрос критериям этого фильтра.
Параметры
-
Cake\Event\Event$event - Событие для сопоставления.
Возвращает
booleanМетоды, используемые из Cake\Core\InstanceConfigTrait
_configDelete()source protected
_configDelete( string $key )
Удаляет один ключ конфигурации
Параметры
- строка
$key - Ключ для удаления.
Исключения
Cake\Core\Exception\Exceptionпри попытке перезаписать существующую конфигурацию
_configRead()source protected
_configRead( string|null $key )
Чтение переменной конфигурации
Параметры
- строка|null
$key - Ключ для чтения.
Возвращает
смешанное_configWrite()source protected
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Запись переменной конфигурации
Параметры
- строка|массив
$key - Ключ для записи.
- смешанное
$value - Значение для записи.
- boolean|строка
$mergeнеобязательно false True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.
Исключения
Cake\Core\Exception\Exceptionпри попытке перезаписи существующей конфигурации
config()source 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 - Значение для установки.
- boolean
$mergeнеобязательно true - Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.
Возвращает
смешанноеЗначение конфигурации, которое читается, или сам объект при операциях записи.
Исключения
Cake\Core\Exception\ExceptionПри попытке установить недопустимый ключ.
configShallow()source 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']);
Параметры
- string|array
$key - Ключ для установки или полный массив настроек.
- mixed|null
$valueнеобязательный null - Значение для установки.
Возвращаемое значение
$this Сам объект.
Подробное описание свойств
$_prioritysource
protected integer
Умолчательный приоритет для всех методов в этом фильтре. Этот фильтр должен выполняться до того, как запрос будет проанализирован маршрутизатором.
9
© 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.2/class-Cake.Routing.Filter.AssetFilter.html