Класс UrlHelper

_encodeUrl()source protected

_encodeUrl( string $url )

Кодирует URL-адрес для использования в атрибутах HTML.

Параметры

строка $url

URL-адрес для кодирования.

Возвращает

строка
URL-адрес, закодированный для контекстов URL и HTML.

_inflectThemeName()source protected

_inflectThemeName( string $name )

Приводит имя темы к нижнему регистру с подчеркиванием.

Параметры

строка $name

Имя темы, которое нужно привести к нижнему регистру с подчеркиванием.

Возвращает

строка
Приведённое к нижнему регистру с подчеркиванием имя темы

assetTimestamp()source public

assetTimestamp( string $path , boolean|string $timestamp = null )

Добавляет отметку времени к ресурсу файла на основе значения Asset.timestamp в Configure. Если Asset.timestamp истинно и debug истинно, или Asset.timestamp равно 'force', будет добавлена отметка времени.

Параметры

строка $path

Путь к файлу, к которому нужно добавить отметку времени, путь должен находиться внутри WWW_ROOT

логическое значение/строка $timestamp необязательно null

Если установлено, переопределит значение Asset.timestamp в Configure.

Возвращает

строка
Путь с добавленной отметкой времени или без.

assetUrl()source public

assetUrl( string|array $path , array $options = [] )

Генерирует URL-адрес для указанного файла ресурса.

В зависимости от переданных параметров предоставляет полный URL-адрес с доменным именем. Также вызывает Helper::assetTimestamp() для добавления отметки времени к локальным файлам.

Параметры

строка/массив $path

Строка пути или массив URL

массив $options необязательно []

Массив опций. Возможные ключи: fullBase Возвращает полный URL-адрес с доменным именем pathPrefix Префикс пути для относительных URL-адресов ext Расширение ресурса для добавления plugin Значение False предотвратит разбор пути как плагина timestamp Переопределяет значение Asset.timestamp в Configure. Установите в значение false, чтобы пропустить генерацию отметки времени. Установите в true, чтобы применять отметки времени, когда debug равен true. Установите в 'force', чтобы всегда включить отметки времени независимо от значения debug.

Возвращает

строка
Сгенерированный URL-адрес

build()source public

build( string|array|null $url = null , array|boolean $options = false )

Возвращает URL-адрес на основе предоставленных параметров.

Опции:

• escape: Если false, URL будет возвращён без экранирования, используйте только если он вручную экранируется перед отображением.
• fullBase: Если true, полный базовый URL будет добавлен в результат

Параметры

строка/массив/null $url необязательно null

Либо относительный строковый URL, например, /products/view/23, либо массив параметров URL. Использование массива для URL позволит использовать функции обратного маршрутизирования CakePHP.

массив/логическое значение $options необязательно false

Массив опций; логическое значение full для совместимости.

Возвращает

строка
Полный переведённый URL-адрес с базовым путём.

css()source public

css( string|array $path , array $options = [] )

Генерирует URL-адрес для указанного файла CSS.

В зависимости от переданных параметров предоставляет полный URL-адрес с доменным именем. Также вызывает Helper::assetTimestamp() для добавления отметки времени к локальным файлам.

Параметры

строка/массив $path

Строка пути или массив URL

массив $options необязательно []

Массив опций. Возможные ключи: fullBase Возвращает полный URL-адрес с доменным именем pathPrefix Префикс пути для относительных URL-адресов ext Расширение ресурса для добавления plugin Значение False предотвратит разбор пути как плагина timestamp Переопределяет значение Asset.timestamp в Configure. Установите в значение false, чтобы пропустить генерацию отметки времени. Установите в true, чтобы применять отметки времени, когда debug равен true. Установите в 'force', чтобы всегда включить отметки времени независимо от значения debug.

Возвращает

строка
Сгенерированный URL-адрес

image()source public

image( string|array $path , array $options = [] )

Генерирует URL-адрес для указанного файла изображения.

В зависимости от переданных параметров предоставляет полный URL-адрес с доменным именем. Также вызывает Helper::assetTimestamp() для добавления отметки времени к локальным файлам.

Параметры

строка/массив $path

Строка пути или массив URL

массив $options необязательно []

Массив опций. Возможные ключи: fullBase Возвращает полный URL-адрес с доменным именем pathPrefix Префикс пути для относительных URL-адресов plugin Значение False предотвратит разбор пути как плагина timestamp Переопределяет значение Asset.timestamp в Configure. Установите в значение false, чтобы пропустить генерацию отметки времени. Установите в true, чтобы применять отметки времени, когда debug равен true. Установите в 'force', чтобы всегда включить отметки времени независимо от значения debug.

Возвращает

строка
Сгенерированный URL-адрес

implementedEvents()source public

implementedEvents( )

Обработчики событий.

Возвращает

массив

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

Cake\View\Helper::implementedEvents()

script()source public

script( string|array $path , array $options = [] )

Генерирует URL для заданного файла javascript.

В зависимости от переданных параметров предоставляет полный URL с именем домена. Также вызывает Helper::assetTimestamp() для добавления отметки времени к локальным файлам.

Параметры

string|array $path

Строка пути или массив URL

array $options optional []

Массив параметров. Возможные ключи: fullBase Возвращает полный URL с именем домена pathPrefix Префикс пути для относительных URL ext Расширение файла-актива для добавления plugin Значение False предотвратит обработку пути как плагина timestamp Переопределяет значение Asset.timestamp в Configure. Установите в значение false, чтобы пропустить генерацию отметки времени. Установите в значение true, чтобы применять отметки времени, когда debug равен true. Установите в 'force', чтобы всегда включить отметки времени независимо от значения debug.

Возвращает

string
Сгенерированный URL

webroot()source public

webroot( string $file )

Проверяет, существует ли файл, когда используется тема; если файл не найден, возвращает значение по умолчанию.

Параметры

string $file

Файл, для которого нужно создать путь webroot.

Возвращает

string
Веб-доступный путь к файлу.

__call()source public

__call( string $method , array $params )

Обеспечивает некритичные ошибки при вызовах отсутствующих методов.

Параметры

string $method

Метод для вызова

array $params

Массив параметров для метода.

__construct()source public

__construct( Cake\View\View $View , array $config = [] )

Конструктор по умолчанию

Параметры

Cake\View\View $View

Представление, к которому прикреплен помощник.

array $config optional []

Параметры конфигурации для помощника.

__debugInfo()source public

__debugInfo( )

Возвращает массив, который может быть использован для описания внутреннего состояния этого объекта.

Возвращает

array

__get()source public

__get( string $name )

Ленично загружает помощники.

Параметры

string $name

Имя свойства, к которому осуществляется доступ.

Возвращает

Cake\View\Helper|null
Экземпляр помощника, если помощник с указанным именем существует

_confirm()source protected

_confirm( string $message , string $okCode , string $cancelCode = '' , array $options = [] )

Возвращает строку, используемую в качестве обработчика onclick для диалоговых окон подтверждения.

Параметры

string $message

Сообщение, которое должно отображаться

string $okCode

Код, который должен быть выполнен после выбора пользователем 'OK'

string $cancelCode optional ''

Код, который должен быть выполнен после выбора пользователем 'Отмена'

array $options optional []

Массив параметров

Возвращает

string
JS-код onclick

addClass()source public

addClass( array $options = [] , string|null $class = null , string $key = 'class' )

Добавляет указанный класс к параметрам элемента.

Параметры

array $options optional []

Массив параметров/атрибутов для добавления класса

string|null $class optional null

Имя добавляемого класса.

string $key optional 'class'

Ключ для использования класса.

Возвращает

array
Массив параметров со свойством $key.

getView()source public

getView( )

Получить экземпляр представления, к которому привязан этот помощник.

Возвращает

Cake\View\View
Экземпляр привязанного представления.

initialize()source public

initialize( array $config )

Метод-обработчик конструктора.

Реализуйте этот метод, чтобы избежать необходимости перезаписывать конструктор и вызывать родительский.

Параметры

array $config

Настройки конфигурации, предоставленные этому помощнику.

_configDelete()source protected

_configDelete( string $key )

Удаляет отдельный ключ конфигурации.

Параметры

string $key

Ключ для удаления.

Исключения

Cake\Core\Exception\Exception
если происходит попытка перезаписать существующую конфигурацию

_configRead()source protected

_configRead( string|null $key )

Считывает ключ конфигурации.

Параметры

string|null $key

Ключ для считывания.

Возвращает

mixed

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge = false )

Записывает ключ конфигурации.

Параметры

string|array $key

Ключ для записи.

mixed $value

Значение для записи.

boolean|string $merge optional 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() вместо этого.

Параметры

string|array|null $key optional null

Ключ для получения/установки или полный массив конфигураций.

mixed|null $value optional null

Значение для установки.

boolean $merge optional true

Выполнять ли рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

mixed
Значение конфигурации, которое считывается, или сам объект при операциях записи.

Исключения

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