PHP Класс Pop\Mvc\Router

Автор: Nick Sagona, III ([email protected])
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$basePath string Base path URI
$controller Controller Current controller object
$controllerClass string Current controller class name string
$controllers array Array of available controllers class names
$project Pop\Project\Project Project object
$request Pop\Http\Request Request object

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

Метод Описание
__construct ( array $controllers, Pop\Http\Request $request = null ) : Router Constructor
addControllers ( array $controller ) : Router Add controllers
controller ( ) : Controller Get the current controller object (shorthand alias)
factory ( array $controllers, Pop\Http\Request $request = null ) : Router Create a Pop\Mvc\Router object
getAction ( ) : string Get action from request within the current controller
getController ( ) : Controller Get the current controller object
getControllerClass ( ) : string Get the current controller class name string
getControllerName ( string $controller ) : string Get a controller class name string, if available
getControllers ( ) : array Get array of controller class names
getProject ( ) : Project Get the project object
getRequest ( ) : Pop\Http\Request Get the request object
project ( ) : Project Get the project object (shorthand alias)
request ( ) : Pop\Http\Request Get the request object (shorthand alias)
route ( Project $project = null ) : void Route to the correct controller

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

Метод Описание
traverseControllers ( array $controllers, integer $depth ) : string Traverse the controllers based on the path

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

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

Instantiate the router object
public __construct ( array $controllers, Pop\Http\Request $request = null ) : Router
$controllers array
$request Pop\Http\Request
Результат Router

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

Add controllers
public addControllers ( array $controller ) : Router
$controller array
Результат Router

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

Get the current controller object (shorthand alias)
public controller ( ) : Controller
Результат Controller

factory() публичный статический Метод

Create a Pop\Mvc\Router object
public static factory ( array $controllers, Pop\Http\Request $request = null ) : Router
$controllers array
$request Pop\Http\Request
Результат Router

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

Get action from request within the current controller
public getAction ( ) : string
Результат string

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

Get the current controller object
public getController ( ) : Controller
Результат Controller

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

Get the current controller class name string
public getControllerClass ( ) : string
Результат string

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

Get a controller class name string, if available
public getControllerName ( string $controller ) : string
$controller string
Результат string

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

Get array of controller class names
public getControllers ( ) : array
Результат array

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

Get the project object
public getProject ( ) : Project
Результат Pop\Project\Project

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

Get the request object
public getRequest ( ) : Pop\Http\Request
Результат Pop\Http\Request

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

Get the project object (shorthand alias)
public project ( ) : Project
Результат Pop\Project\Project

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

Get the request object (shorthand alias)
public request ( ) : Pop\Http\Request
Результат Pop\Http\Request

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

Route to the correct controller
public route ( Project $project = null ) : void
$project Pop\Project\Project
Результат void

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

Traverse the controllers based on the path
protected traverseControllers ( array $controllers, integer $depth ) : string
$controllers array
$depth integer
Результат string

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

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

Base path URI
protected string $basePath
Результат string

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

Current controller object
protected Controller,Pop\Mvc $controller
Результат Controller

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

Current controller class name string
protected string $controllerClass
Результат string

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

Array of available controllers class names
protected array $controllers
Результат array

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

Project object
protected Project,Pop\Project $project
Результат Pop\Project\Project

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

Request object
protected Request,Pop\Http $request
Результат Pop\Http\Request