class PackageRouter implements RouteBuilderInterface (View source)

The PackageRouter class, it is a decoration pattern to wrap package and router object.

Traits

The RouteBuilderTrait class.

Methods

string
route(string $route, array $queries = array(), string $type = MainRouter::TYPE_PATH)

build

string
fullRoute(string $route, array $queries = array())

fullRoute

string
rawRoute(string $route, array $queries = array())

rawRoute

string
escape(string $text)

escape

__construct(MainRouter $router, AbstractPackage $package = null)

Class init.

mixed
__call(string $name, array $args)

__call

getRouter()

Method to get property Router

setRouter(MainRouter $router)

Method to set property router

Route
getMatched()

getMatched

getPackage()

Method to get property Package

setPackage(AbstractPackage $package = null)

Method to set property package

Details

at line line 60
string route(string $route, array $queries = array(), string $type = MainRouter::TYPE_PATH)

build

Parameters

string $route
array $queries
string $type

Return Value

string

Exceptions

OutOfRangeException

string fullRoute(string $route, array $queries = array())

fullRoute

Parameters

string $route
array $queries

Return Value

string

string rawRoute(string $route, array $queries = array())

rawRoute

Parameters

string $route
array $queries

Return Value

string

string escape(string $text)

escape

Parameters

string $text

Return Value

string

at line line 43
__construct(MainRouter $router, AbstractPackage $package = null)

Class init.

Parameters

MainRouter $router
AbstractPackage $package

at line line 94
mixed __call(string $name, array $args)

__call

Parameters

string $name
array $args

Return Value

mixed

at line line 104
MainRouter getRouter()

Method to get property Router

Return Value

MainRouter

at line line 116
PackageRouter setRouter(MainRouter $router)

Method to set property router

Parameters

MainRouter $router

Return Value

PackageRouter Return self to support chaining.

at line line 128
Route getMatched()

getMatched

Return Value

Route

at line line 138
AbstractPackage getPackage()

Method to get property Package

Return Value

AbstractPackage

at line line 150
PackageRouter setPackage(AbstractPackage $package = null)

Method to set property package

Parameters

AbstractPackage $package

Return Value

PackageRouter Return self to support chaining.