Spec-Zone.ru › CakePHP 3.1

Класс InflectedRoute

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

Cake\Routing\Route\Route
Extended by Cake\Routing\Route\InflectedRoute

Прямые известные подклассы

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

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

_underscoresource protected

_underscore( array $url )

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

Параметры

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

Возвращает

array
массив

matchsource public

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

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

Параметры

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

Возвращает

string|false
Строка URL для параметров, если они совпадают, или false.

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

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

parsesource public

parse( string $url )

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

Параметры

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

Возвращает

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

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

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

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

__constructsource public

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

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

Параметры

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

Параметры

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

__set_statesource public static

__set_state( array $fields )

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

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

Параметры

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

Возвращает

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

_matchMethodsource protected

_matchMethod( array $url )

Проверяет, соответствует ли HTTP-метод URL.

Параметры

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

Возвращает

boolean
bool

_parseArgssource protected

_parseArgs( string $args , string $context )

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

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

Параметры

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

Возвращает

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

_parseExtensionsource protected

_parseExtension( string $url )

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

Параметры

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

Возвращает

array
содержащий URL, расширение

_persistParamssource protected

_persistParams( array $url , array $params )

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

Параметры

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

Возвращает

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

_writeRoutesource protected

_writeRoute( )

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

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

_writeUrlsource protected

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

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

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

Параметры

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

Возвращает

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

compilesource public

compile( )

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

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

Возвращает

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

compiledsource public

compiled( )

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

Возвращает

boolean
bool

extensionssource public

extensions( null|string|array $extensions null )

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

Параметры

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

Возвращает

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

getNamesource public

getName( )

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

Возвращает

string
строка

staticPathsource public

staticPath( )

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

Возвращает

string
строка

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

$_inflectedDefaultssource

protected boolean

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

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

false

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

$_compiledRoutesource

protected string

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

null

$_extensionssource

protected array

Список подключенных расширений для этого маршрута.

[]

$_greedysource

protected string

Является ли этот маршрут жадным? Жадные маршруты содержат /* в своём шаблоне

false

$_namesource

protected string

Имя маршрута. Получить с помощью Route::getName();

null

$defaultssource

public array

Параметры по умолчанию для маршрута

[]

$keyssource

public array

Массив именованных сегментов в маршруте. /:controller/:action/:id содержит 3 ключевых элемента

[]

$optionssource

public array

Массив дополнительных параметров для маршрута.

[]

$templatesource

public string

Строка шаблона маршрута.

null

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Routing.Route.InflectedRoute.html

Spec-Zone.ru

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