Класс 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Если условия 'когда' не вызываемый объект.
Переопределяет
Cake\Routing\DispatcherFilter::__construct() _deliverAsset()source protected
_deliverAsset( Cake\Http\ServerRequest $request , Cake\Http\Response $response , string $assetFile , string $ext )
Отправляет файл ресурса клиенту
Параметры
-
Cake\Http\ServerRequest$request - Объект запроса для использования.
-
Cake\Http\Response$response - Объект ответа для использования.
- строка
$assetFile - Путь к файлу ресурса в файловой системе
- строка
$ext - Расширение файла для определения типа MIME
Возвращает
Cake\Http\ResponseОбновленный объект ответа.
_getAssetFile()source protected
_getAssetFile( string $url )
Строит путь к файлу ресурса на основе URL
Параметры
- строка
$url - URL ресурса
Возвращает
строкаАбсолютный путь к файлу ресурса
beforeDispatch()source public
beforeDispatch( Cake\Event\Event $event )
Проверяет существование запрошенного ресурса и отправляет его в браузер
Параметры
-
Cake\Event\Event$event - Событие, содержащее объект запроса и ответа
Возвращает
Cake\Http\Response|nullЕсли клиент запрашивает распознаваемый ресурс, null в противном случае
Исключения
Cake\Http\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 уведомляет о 2 различных событиях Dispatcher.before и Dispatcher.after. По умолчанию этот класс подключает методы preDispatch и postDispatch соответственно.
Переопределите этот метод по своему усмотрению, чтобы отслеживать только интересующие вас события.
Возвращает
массивРеализация
Cake\Event\EventListenerInterface::implementedEvents() matches()source public
matches( Cake\Event\Event $event )
Проверка соответствия запроса критериям этого фильтра.
Параметры
-
Cake\Event\Event$event - Событие для соответствия.
Возвращает
логическое значениеМетоды, используемые из 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 - Значение для записи.
- логическое значение|строка
$mergeнеобязательно false True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.
Исключения
Cake\Core\Exception\Exceptionпри попытке перезаписи существующей конфигурации
config()source public deprecated
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']);
Устарело
3.4.0 использовать setConfig()/getConfig() вместо этого.Параметры
- строка|массив|null
$keyнеобязательно null - Ключ для получения/установки или массив конфигураций.
- смешанный|null
$valueнеобязательно null - Значение для установки.
- логическое значение
$mergeнеобязательно true - Рекурсивно сливать или перезаписывать существующую конфигурацию, по умолчанию true.
Возвращает
смешанныйЧтение значения конфигурации, или сам объект при операциях записи.
Исключения
Cake\Core\Exception\ExceptionПри попытке установить недопустимый ключ.
configShallow()source public
configShallow( string|array $key , mixed|null $value = null )
Объединить предоставленные конфигурации с существующей. В отличие от config(), которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
Установка определённого значения:
$this->configShallow('key', $value); Установка вложенного значения:
$this->configShallow('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->configShallow(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки или массив настроек.
- смешанный|null
$valueнеобязательно null - Значение для установки.
Возвращаемое значение
$this
getConfig()source public
getConfig( string|null $key = null , mixed $default = null )
Возвращает конфигурацию.
Использование
Чтение всей конфигурации:
$this->getConfig();
Чтение определённого значения:
$this->getConfig('key'); Чтение вложенного значения:
$this->getConfig('some.nested.key'); Чтение со значением по умолчанию:
$this->getConfig('some-key', 'default-value'); Параметры
- строка|null
$keyнеобязательно null - Ключ для получения или null для всей конфигурации.
- смешанный
$defaultнеобязательно null - Возвращаемое значение, если ключ не существует.
Возвращаемое значение
смешанныйДанные конфигурации по указанному ключу или null, если ключ не существует.
setConfig()source public
setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )
Устанавливает конфигурацию.
Использование
Установка определённого значения:
$this->setConfig('key', $value); Установка вложенного значения:
$this->setConfig('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->setConfig(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки или массив настроек.
- смешанный|null
$valueнеобязательно null - Значение для установки.
- boolean
$mergeнеобязательно true - Выполнять рекурсивное объединение или перезаписывать существующую конфигурацию, по умолчанию true.
Возвращаемое значение
$this
Исключения
Cake\Core\Exception\ExceptionПри попытке установить недопустимый ключ.
Подробное описание свойств
$_prioritysource
protected целое число
Приоритет по умолчанию для всех методов в этом фильтре. Этот фильтр должен выполняться до того, как запрос будет обработан маршрутизатором.
9
© 2005–present 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.
https://api.cakephp.org/3.8/class-Cake.Routing.Filter.AssetFilter.html