Spec-Zone.ru › CakePHP 4.2

Класс UrlHelper

Класс UrlHelper для генерации URL-адресов.

Пространство имён: Cake\View\Helper

Краткое описание свойств

  • $_View protected
    Cake\View\View

    Экземпляр View, к которому прикреплён этот хелпер

  • $_assetUrlClassName protected
    string

    Имя класса движка URL-адресов ресурсов

  • $_config protected
    array

    Конфигурация во время выполнения

  • $_configInitialized protected
    bool

    Указывает, была ли конфигурация уже настроена по умолчанию

  • $_defaultConfig protected
    array

    Конфигурация по умолчанию для этого класса

  • $_helperMap protected
    array

    Таблица поиска хелперов, используемая для ленивой загрузки объектов хелперов.

  • $helpers protected
    array

    Список хелперов, используемых этим хелпером

Краткое описание методов

  • __call() public

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

  • __construct() public

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

  • __debugInfo() public

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

  • __get() public

    Лениво загружает хелперы.

  • _configDelete() protected

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

  • _configRead() protected

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

  • _configWrite() protected

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

  • _confirm() protected

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

  • addClass() public

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

  • assetTimestamp() public

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

  • assetUrl() public

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

  • build() public

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

  • buildFromPath() public

    Возвращает URL из строки пути маршрута.

  • configShallow() public

    Объединяет предоставленную конфигурацию с существующей. В отличие от config(), который выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.

  • css() public

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

  • getConfig() public

    Возвращает конфигурацию.

  • getConfigOrFail() public

    Возвращает конфигурацию для данного ключа.

  • getView() public

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

  • image() public

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

  • implementedEvents() public

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

  • initialize() public

    Проверка корректности конфигурации

  • script() public

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

  • setConfig() public

    Устанавливает конфигурацию.

  • webroot() public

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

Подробное описание методов

__call() public 

__call(string $method, array $params): mixed|void

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

Параметры

string $method

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

array $params

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

Возвращает

mixed|void

__construct() public 

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

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

Параметры

Cake\View\View $view

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

array $config optional

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

__debugInfo() public 

__debugInfo(): array

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

Возвращает

array

__get() public 

__get(string $name): Cake\View\Helper|null|void

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

Параметры

string $name

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

Возвращает

Cake\View\Helper|null|void

_configDelete() protected 

_configDelete(string $key): void

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

Параметры

string $key

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

Возвращает

void

Выбрасывает

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

_configRead() protected 

_configRead(string|null $key): mixed

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

Параметры

string|null $key

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

Возвращает

mixed

_configWrite() protected 

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

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

Параметры

string|array $key

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

mixed $value

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

bool|string $merge optional

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

Возвращает

void

Выбрасывает

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

_confirm() protected 

_confirm(string $okCode, string $cancelCode): string

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

Параметры

string $okCode

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

string $cancelCode

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

Возвращает

string

addClass() public 

addClass(array $options, string $class, string $key = 'class'): array

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

Параметры

array $options

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

string $class

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

string $key optional

Ключ, который нужно использовать для класса. По умолчанию 'class'.

Возвращает

array

assetTimestamp() public 

assetTimestamp(string $path, bool|string $timestamp = null): string

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

Параметры

string $path

Путь к файлу, которому нужно добавить отметку времени. Путь должен быть внутри App.wwwRoot в Configure.

bool|string $timestamp optional

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

Возвращает

string

assetUrl() public 

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

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

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

Опции:

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

Параметры

string $path

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

array $options optional

Массив опций.

Возвращает

string

build() public 

build(string|array|null $url = null, array $options = []): string

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

Опции:

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

Параметры

string|array|null $url optional

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

array $options optional

Массив опций.

Возвращает

string

buildFromPath() public 

buildFromPath(string $path, array $params = [], array $options = []): string

Возвращает URL из строки пути маршрута.

Опции:

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

Параметры

string $path

Путь маршрута, относительный к Cake.

array $params optional

Массив, определяющий любые дополнительные параметры. Может также быть любыми специальными параметрами, поддерживаемыми Router::url().

array $options optional

Массив опций.

Возвращает

string

См. также

\Cake\Routing\Router::pathUrl()

configShallow() public 

configShallow(string|array $key, mixed|null $value = null): $this

Объединяет переданную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка конкретного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

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

mixed|null $value optional

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

Возвращает

$this

css() public 

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

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

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

Параметры

string $path

Строка пути.

array $options optional

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

Возвращает

string

getConfig() public 

getConfig(string|null $key = null, mixed $default = null): mixed

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key optional

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

mixed $default optional

Возвращаемое значение, когда ключ не существует.

Возвращает

mixed

getConfigOrFail() public 

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для данного ключа.

Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.

Параметры

string $key

Ключ для получения.

Возвращает

mixed

Исключения

InvalidArgumentException

getView() public 

getView(): Cake\View\View

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

Возвращает

Cake\View\View

image() public 

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

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

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

Параметры

string $path

Строка пути.

array $options optional

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

Возвращает

string

implementedEvents() public 

implementedEvents(): array

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

Определяя одну из методов обратного вызова, помощник предполагается заинтересованным в соответствующем событии.

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

Возвращает

array

initialize() public 

initialize(array $config): void

Проверка правильности конфигурации

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

Параметры

array $config

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

Возвращает

void

script() public 

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

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

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

Параметры

string $path

Строка пути.

array $options optional

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

Возвращает

string

setConfig() public 

setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this

Устанавливает конфигурацию.

Использование

Установка определенного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

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

mixed|null $value optional

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

bool $merge optional

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

Возвращает

$this

Исключения

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

webroot() public 

webroot(string $file): string

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

Параметры

string $file

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

Возвращает

string

Подробное описание свойств

$_View protected

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

Тип

Cake\View\View

$_assetUrlClassName protected

Имя класса движка URL ресурсов

Тип

string

$_config protected

Конфигурация выполнения

Тип

array

$_configInitialized protected

Указывает, была ли конфигурация уже настроена с значениями по умолчанию

Тип

bool

$_defaultConfig protected

Конфигурация по умолчанию для этого класса

Тип

array

$_helperMap protected

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

Тип

array

$helpers protected

Список помощников, используемых этим помощником

Тип

array

© 2005–present 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/4.2/class-Cake.View.Helper.UrlHelper.html

Spec-Zone.ru

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