Класс AssetFilter

__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\Http\Exception\NotFoundException
Когда ресурс не найден

Переопределяет

Cake\Routing\DispatcherFilter::beforeDispatch()

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

Событие для проверки.

Возвращает

логическое

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

Параметры

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

'+1 day'

9