Spec-Zone.ru › CakePHP 3.3

Класс InflectedRoute

Этот класс маршрутов прозрачно склоняет параметры маршрутизации контроллера и плагина, так что запрос /my_controller анализируется как ['controller' => 'MyController']

Cake\Routing\Route\Route
Расширенный Cake\Routing\Route\InflectedRoute

Непосредственные подклассы

  • Cake\Routing\Route\PluginShortRoute
Пространство имён: Cake\Routing\Route
Расположение: Routing/Route/InflectedRoute.php

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

  • $_inflectedDefaults protected
    boolean
    Флаг для отслеживания того, были ли значения по умолчанию склонены.

Наследованные свойства

  • _compiledRoute, _extensions, _greedy, _name, defaults, keys, options, template

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

  • _underscore() protected
    Вспомогательный метод для подчеркивания ключей в массиве URL.
  • match() public

    Подчёркивает префикс, контроллер и параметры плагина перед передачей их родительскому классу

  • parse() public

    Разбирает строковый URL в массив. Если он соответствует, то преобразует ключи префикса, контроллера и плагина в их камелизированную форму.

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

_underscore()source protected

_underscore( array $url )

Вспомогательный метод для подчеркивания ключей в массиве URL.

Параметры

массив $url
Массив ключей URL.

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

массив

match()source public

match( array $url , array $context [] )

Подчёркивает префикс, контроллер и параметры плагина перед передачей их родительскому классу

Параметры

массив $url
Массив параметров для преобразования в строку.
массив $context необязательный []

Массив текущего контекста запроса. Содержит информацию, такую как текущий хост, схему, порт и базовый каталог.

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

строка|ложь
Строка URL параметров, если они соответствуют, или ложь в случае неудачи.

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

Cake\Routing\Route\Route::match()

parse()source public

parse( string $url , string $method '' )

Разбирает строковый URL в массив. Если он соответствует, то преобразует ключи префикса, контроллера и плагина в их камелизированную форму.

Параметры

строка $url
URL для разбора
строка $method необязательный ''
HTTP-метод, к которому осуществляется сопоставление.

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

массив|ложь
Массив параметров запроса или ложь при ошибке.

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

Cake\Routing\Route\Route::parse()

Методы, унаследованные от Cake\Routing\Route\Route

__construct()source public

__construct( string $template , array|string $defaults [] , array $options [] )

Конструктор маршрута

Параметры

  • _ext - Определяет расширения, используемые для этого маршрута.
  • pass - Копирует указанные параметры в params['pass'].

Параметры

строка $template
Шаблонная строка с заменителями параметров
массив|строка $defaults необязательный []
Значения по умолчанию для маршрута.
массив $options необязательный []
Массив дополнительных параметров для маршрута

__set_state()source public static

__set_state( array $fields )

Магический метод установки состояния для поддержки var_export

Этот метод помогает приложениям, которые хотят реализовать кэширование маршрутизатора.

Параметры

массив $fields
Ключ/значение атрибутов объекта

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

Cake\Routing\Route\Route
Новый экземпляр маршрута

_matchMethod()source protected

_matchMethod( array $url )

Проверка соответствия HTTP-метода URL.

Параметры

массив $url
Массив для генерируемого URL.

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

булево

_parseArgs()source protected

_parseArgs( string $args , string $context )

Разбор переданных параметров в список переданных аргументов.

Возвращает true, если заданное имя параметра $param's $val соответствует заданному $rule в зависимости от $context. В настоящее время реализованы типы правил контроллера, действия и соответствия, которые могут быть объединены друг с другом.

Параметры

строка $args
Строка с переданными параметрами. Пример: /1/foo
строка $context
Текущий контекст маршрута, который должен содержать ключи контроллера/действия.

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

массив
Массив переданных аргументов.

_parseExtension()source protected

_parseExtension( string $url )

Удаляет расширение из $url, если он содержит зарегистрированное расширение. Если зарегистрированное расширение не найдено, расширение не возвращается, и URL возвращается без изменений.

Параметры

строка $url
URL для разбора.

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

массив
содержащий url, расширение

_persistParams()source protected

_persistParams( array $url , array $params )

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

Параметры

массив $url
Массив, к которому применяются постоянные параметры.
массив $params
Массив постоянных значений для замены постоянных.

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

массив
Массив с применёнными постоянными параметрами.

_writeRoute()source protected

_writeRoute( )

Строит регулярное выражение маршрута.

Использует свойства template, defaults и options для компиляции регулярного выражения, которое может использоваться для анализа строк запросов.

_writeUrl()source protected

_writeUrl( array $params , array $pass [] , array $query [] )

Преобразует сопоставимый массив маршрута в строку URL.

Составляет строковый URL, используя шаблон, используемый для создания маршрута.

Параметры

массив $params
Параметры для преобразования в строку url
массив $pass необязательный []
Дополнительные переданные аргументы
массив $query необязательный []
Массив параметров

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

строка
Составленная строка маршрута.

compile()source public

compile( )

Компилирует регулярное выражение маршрута.

Изменяет свойство defaults, чтобы все необходимые ключи были установлены, и заполняет $this->names именованными элементами маршрутизации.

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

массив
Возвращает строку регулярного выражения скомпилированного маршрута.

compiled()source public

compiled( )

Проверка, скомпилирован ли маршрут в регулярное выражение.

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

булево
END_OF_DOCUMENT_MARKER

extensions()source public

extensions( null|string|array $extensions null )

Получить/установить поддерживаемые расширения для этого маршрута.

Устаревшее

3.3.9 Используйте getExtensions/setExtensions вместо этого.

Параметры

null|string|array $extensions необязательно null
Расширения для установки. Используйте null для получения.

Возвращает

array|null
Расширения или null.

getExtensions()source public

getExtensions( )

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

Возвращает

array

getName()source public

getName( )

Получить стандартизированное имя плагина.контроллера:действие для маршрута.

Возвращает

string

setExtensions()source public

setExtensions( array $extensions )

Установить поддерживаемые расширения для этого маршрута.

Параметры

array $extensions
Расширения для установки.

Возвращает


$this

staticPath()source public

staticPath( )

Получить статическую часть пути для этого маршрута.

Возвращает

string

Подробности свойств

$_inflectedDefaultssource

protected boolean

Флаг для отслеживания того, были ли значения по умолчанию склонены.

Значения по умолчанию должны быть склонены, чтобы они соответствовали склонениям, которые создаст match().

false

© 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.3/class-Cake.Routing.Route.InflectedRoute.html

Spec-Zone.ru

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