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

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

Параметры

строка $path

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

Возвращает

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

assetUrl()source public

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

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

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

Параметры

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

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

массив $options optional []

Массив опций. Возможные ключи: fullBase Возвратить полный URL с доменным именем pathPrefix Префикс пути для относительных URL ext Расширение ресурса для добавления plugin Значение False предотвратит обработку пути как плагина

Возвращает

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

build()source public

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

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

Опции:

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

Параметры

строка|массив|null $url optional null

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

массив|булево $options optional false

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

Возвращает

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

css()source public

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

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

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

Параметры

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

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

массив $options optional []

Массив опций. Возможные ключи: fullBase Возвратить полный URL с доменным именем pathPrefix Префикс пути для относительных URL ext Расширение ресурса для добавления plugin Значение False предотвратит обработку пути как плагина

Возвращает

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

image()source public

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

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

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

Параметры

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

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

массив $options optional []

Массив опций. Возможные ключи: fullBase Возвратить полный URL с доменным именем pathPrefix Префикс пути для относительных URL plugin Значение False предотвратит обработку пути как плагина

Возвращает

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

implementedEvents()source public

implementedEvents( )

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

Возвращает

массив

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

Cake\View\Helper::implementedEvents()

script()source public

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

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

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

Параметры

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

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

массив $options optional []

Массив опций. Возможные ключи: fullBase Возвратить полный URL с доменным именем pathPrefix Префикс пути для относительных URL ext Расширение ресурса для добавления plugin Значение False предотвратит обработку пути как плагина

Возвращает

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

webroot()source public

webroot( string $file )

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

Параметры

строка $file

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

Возвращает

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

__call()source public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

__construct()source public

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

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

Параметры

Cake\View\View $View

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

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

Настройки конфигурации для помощника.

__debugInfo()source public

__debugInfo( )

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

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

массив

__get()source public

__get( string $name )

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

Параметры

строка $name

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

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

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

_confirm()source protected

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

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

Параметры

строка $message

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

строка $okCode

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

строка $cancelCode необязательно ''

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

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

Массив опций

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

строка
JS-код onclick

addClass()source public

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

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

Параметры

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

Массив опций/атрибутов, к которым нужно добавить класс

строка|null $class необязательно null

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

строка $key необязательно 'class'

Ключ, используемый для класса.

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

массив
Массив опций со значением $key.

initialize()source public

initialize( array $config )

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

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

Параметры

массив $config

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

_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

Истина для рекурсивного слияния, 'shallow' для простого слияния, ложь для перезаписи, по умолчанию ложь.

Исключения

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

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

булево $merge необязательно true

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

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

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

Исключения

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

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

Параметры

строка|массив $key

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

смешанный|null $value необязательно null

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

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

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