PHP Class luya\base\ModuleReflection

Author: nadar

Inheritance: extends yii\base\Object

Public Properties

Property	Type	Description
$controller		The controller paramter is null until the ModuleReflection::run method has been applied.
$request		Request object from DI-Container.
$urlManager		UrlManager object from DI-Container.

Method	Description
__construct ( luya\web\Request $request, luya\web\UrlManager $urlManager, array $config = [] )	Class constructor in order to consum from DI Container.
defaultRoute ( string $controller, string $action = null, array $args = [] )	Inject a defaultRoute.
getModule ( ) : Module	Getter for the module property.
getRequestRoute ( ) : array	Determine the default route based on current defaultRoutes or parsedRequested by the UrlManager.
getSuffix ( ) : string	Getter for the suffix property.
getUrlRule ( ) : array	Returns the url rule parameters which are taken from the requested route.
init ( )
run ( ) : string \| Response	Run the route based on the values.
setModule ( Module $module )	Setter for the module property.
setSuffix ( string $suffix )	Setter for the suffix property.

Class constructor in order to consum from DI Container.

public __construct ( luya\web\Request $request, luya\web\UrlManager $urlManager, array $config = [] )
$request	luya\web\Request
$urlManager	luya\web\UrlManager
$config	array

Inject a defaultRoute.

public defaultRoute ( string $controller, string $action = null, array $args = [] )
$controller	string
$action	string
$args	array

Getter for the module property.

public getModule ( ) : Module
return	Module

Determine the default route based on current defaultRoutes or parsedRequested by the UrlManager.

public getRequestRoute ( ) : array
return	array

Getter for the suffix property.

public getSuffix ( ) : string
return	string

Returns the url rule parameters which are taken from the requested route.

public getUrlRule ( ) : array
return	array

public init ( )

Run the route based on the values.

public run ( ) : string \| Response
return	string \| yii\web\Response	The response of the action, can be either a string or an object from response.

Setter for the module property.

public setModule ( Module $module )
$module	Module

Setter for the suffix property.

public setSuffix ( string $suffix )
$suffix	string

The controller paramter is null until the ModuleReflection::run method has been applied.

public $controller

Request object from DI-Container.

public $request

UrlManager object from DI-Container.

public $urlManager