Spec-Zone.ru › CakePHP 3.5

Класс AssetFilter

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

Cake\Routing\DispatcherFilter реализует Cake\Event\EventListenerInterface использует 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\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\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 уведомляет о двух разных событиях 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

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

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']);

Параметры

string|array $key
Ключ для установки или массив конфигураций.
mixed|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');

Параметры

string|null $key необязательно null
Ключ для получения или null для всей конфигурации.
mixed $default необязательно null
Возвращаемое значение, если ключ не существует.

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

mixed
Значение считанной конфигурации.

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']);

Параметры

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

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


$this

Исключения

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

Подробности свойств

$_cacheTimesource

protected string

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

'+1 day'

$_prioritysource

protected integer

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

9

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

Spec-Zone.ru

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