Spec-Zone.ru › CakePHP 3.3

Класс 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

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

  • $_cacheTime protected
    string
    Время кэширования ресурса.
  • $_priority protected
    integer

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

Унаследованные свойства

  • _defaultConfig _config, _configInitialized

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

  • __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.

Возвращает

Cake\Network\Response
Обновлённый объект ответа.

_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
Если клиент запрашивает распознаваемый ресурс, 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
Событие для проверки соответствия.

Возвращает

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

Унаследованные методы от 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
При попытке установить недопустимый ключ.
END_OF_DOCUMENT_MARKER

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 optional null
Значение для установки.

Возвращаемое значение


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

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

$_cacheTimesource

protected string

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

'+1 day'

$_prioritysource

protected integer

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

9

© 2005–2017 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.3/class-Cake.Routing.Filter.AssetFilter.html

Spec-Zone.ru

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