Spec-Zone.ru › CakePHP 3.4

Класс 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\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.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–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.4/class-Cake.Routing.Filter.AssetFilter.html

Spec-Zone.ru

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