PHP Класс Visithor\Generator\UrlGenerator

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$urlChainFactory Visithor\Factory\UrlChainFactory UrlChain factory
$urlFactory Visithor\Factory\UrlFactory Url factory

Открытые методы

Метод Описание
__construct ( UrlFactory $urlFactory, UrlChainFactory $urlChainFactory ) Construct
generate ( array $config ) : UrlChain Given a configuration array, generates a chain of urls

Защищенные методы

Метод Описание
createUrlChainFromConfig ( array $config, array $defaultHTTPCodes, array $defaultOptions ) : Url[] Given a config array, create an URLChain instance filled with all defined URL instances.
getDefaultHTTPCodes ( array $config ) : string[] Get default http Codes
getDefaultOptions ( array $config ) : array Get default options
getUrlHTTPCodesFromConfig ( mixed $urlConfig, array $defaultHTTPCodes ) : string[] Get url HTTP Codes given its configuration
getUrlInstanceFromConfig ( mixed $urlConfig, array $defaultHTTPCodes, array $defaultOptions, array $profiles ) : URL Get Url instance given its configuration
getUrlOptionsFromConfig ( mixed $urlConfig, array $defaultOptions ) : string[] Get url options
getUrlPathFromConfig ( mixed $urlConfig ) : string Build the url given the configuration data

Описание методов

__construct() публичный Метод

Construct
public __construct ( UrlFactory $urlFactory, UrlChainFactory $urlChainFactory )
$urlFactory Visithor\Factory\UrlFactory Url factory
$urlChainFactory Visithor\Factory\UrlChainFactory UrlChain factory

createUrlChainFromConfig() защищенный Метод

Given a config array, create an URLChain instance filled with all defined URL instances.
protected createUrlChainFromConfig ( array $config, array $defaultHTTPCodes, array $defaultOptions ) : Url[]
$config array Configuration
$defaultHTTPCodes array Array of HTTP Codes
$defaultOptions array Default options
Результат Visithor\Model\Url[] Array of URL instances

generate() публичный Метод

Given a configuration array, generates a chain of urls
public generate ( array $config ) : UrlChain
$config array Configuration
Результат Visithor\Model\UrlChain Chain of URL instances

getDefaultHTTPCodes() защищенный Метод

Get default http Codes
protected getDefaultHTTPCodes ( array $config ) : string[]
$config array Configuration
Результат string[] Array of HTTP Codes

getDefaultOptions() защищенный Метод

Get default options
protected getDefaultOptions ( array $config ) : array
$config array Configuration
Результат array Default options

getUrlHTTPCodesFromConfig() защищенный Метод

Get url HTTP Codes given its configuration
protected getUrlHTTPCodesFromConfig ( mixed $urlConfig, array $defaultHTTPCodes ) : string[]
$urlConfig mixed Url configuration
$defaultHTTPCodes array Array of HTTP Codes
Результат string[] Set of HTTP Codes

getUrlInstanceFromConfig() защищенный Метод

Get Url instance given its configuration
protected getUrlInstanceFromConfig ( mixed $urlConfig, array $defaultHTTPCodes, array $defaultOptions, array $profiles ) : URL
$urlConfig mixed Url configuration
$defaultHTTPCodes array Array of HTTP Codes
$defaultOptions array Default options
$profiles array Profiles
Результат URL Url instance

getUrlOptionsFromConfig() защищенный Метод

Get url options
protected getUrlOptionsFromConfig ( mixed $urlConfig, array $defaultOptions ) : string[]
$urlConfig mixed Url configuration
$defaultOptions array Default options
Результат string[] Set of HTTP Codes

getUrlPathFromConfig() защищенный Метод

Build the url given the configuration data
protected getUrlPathFromConfig ( mixed $urlConfig ) : string
$urlConfig mixed Url configuration
Результат string Route path

Описание свойств

$urlChainFactory защищенное свойство

UrlChain factory
protected UrlChainFactory,Visithor\Factory $urlChainFactory
Результат Visithor\Factory\UrlChainFactory

$urlFactory защищенное свойство

Url factory
protected UrlFactory,Visithor\Factory $urlFactory
Результат Visithor\Factory\UrlFactory