phpDocumentor router
[ class tree: router ] [ index: router ] [ all elements ]

Class: AbstractWindRouter

Source Location: /router/AbstractWindRouter.php

Class AbstractWindRouter

Class Overview

路由解析器接口

职责: 路由解析,Url构建.实现路由解析器必须实现该接口的{@see AbstractWindRouter::route()}方法.该抽象类支持多路由协议处理.

Located in /router/AbstractWindRouter.php [line 12]

WindModule
   |
   --WindHandlerInterceptorChain
      |
      --AbstractWindRouter
Author(s): API Tags:
Abstract:  

Information Tags:
Version:  $Id: AbstractWindRouter.php 3389 2012-03-12 15:44:22Z yishuo $
Copyright:  ©2003-2103 phpwind.com
License:  http://www.windframework.com

Properties

Methods

[ Top ]
Descendants
Child Class Description
WindRouter wind路由基础实现

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From WindHandlerInterceptorChain

WindHandlerInterceptorChain::$_args
WindHandlerInterceptorChain::$_callBack
WindHandlerInterceptorChain::$_interceptors

Inherited From WindModule

WindModule::$_config
WindModule::$_proxy
WindModule::$_typeValidation

Inherited From WindHandlerInterceptorChain

WindHandlerInterceptorChain::addInterceptors()
添加拦截连中的拦截器对象
WindHandlerInterceptorChain::getHandler()
返回拦截链中的下一个拦截器
WindHandlerInterceptorChain::handle()
执行callback方法
WindHandlerInterceptorChain::reset()
重置拦截链初始化信息
WindHandlerInterceptorChain::setCallBack()
设置回调方法

Inherited From WindModule

WindModule::getConfig()
根据配置名取得相应的配置
WindModule::getRequest()
返回当前应用的WindHttpRequest对象
WindModule::getResponse()
返回当前应用的WindHttpResponse对象
WindModule::getSystemFactory()
返回当前应用的WindFactory对象
WindModule::setConfig()
设置类配置
WindModule::setDelayAttributes()
设置延迟加载类属性相关组件配置信息
WindModule::toArray()
返回该对象的数组类型
WindModule::writeTableCloneProperty()
类对象clone白名单
WindModule::__call()
重载了魔术方法__call
WindModule::__clone()
重载魔术方法__clone
WindModule::__get()
重载了魔术方法__get
WindModule::__set()
重载了魔术方法__set

[ Top ]
Property Summary
mixed   $action  
mixed   $actionKey  
mixed   $controller  
mixed   $controllerKey  
mixed   $defaultRoute  
mixed   $module  
mixed   $moduleKey  
mixed   $_action  
mixed   $_controller  
mixed   $_module  

[ Top ]
Method Summary
void   addRoute()   添加路由协议对象,如果添加的路由协议已经存在则抛出异常
string   assemble()   创建Url,并返回构建好的Url值
string   getAction()   返回action
string   getActionKey()  
string   getController()   返回controller
string   getControllerKey()  
string   getDefaultAction()   返回默认的action值
string   getDefaultController()   返回默认的controller值
string   getDefaultModule()   返回默认的module值
string   getModule()  
string   getModuleKey()  
AbstractWindRoute   getRoute()   根据rule的规则名称,从路由链中获得该路由的对象
string   route()   路由解析
void   setAction()   设置action
void   setActionKey()  
void   setConfig()  
void   setController()   设置controller
void   setControllerKey()  
void   setModule()  
void   setModuleKey()  
void   setParams()   将路由解析到的url参数信息保存早系统变量中

[ Top ]
Properties
mixed   $action = 'run' [line 18]
API Tags:
Access:  protected


[ Top ]
mixed   $actionKey = 'a' [line 15]
API Tags:
Access:  protected


[ Top ]
mixed   $controller = 'index' [line 17]
API Tags:
Access:  protected


[ Top ]
mixed   $controllerKey = 'c' [line 14]
API Tags:
Access:  protected


[ Top ]
mixed   $defaultRoute = '' [line 20]
API Tags:
Access:  protected


[ Top ]
mixed   $module = 'default' [line 16]
API Tags:
Access:  protected


[ Top ]
mixed   $moduleKey = 'm' [line 13]
API Tags:
Access:  protected


[ Top ]
mixed   $_action [line 22]
API Tags:
Access:  protected


[ Top ]
mixed   $_controller [line 23]
API Tags:
Access:  protected


[ Top ]
mixed   $_module [line 24]
API Tags:
Access:  protected


[ Top ]
Methods
addRoute  [line 92]

  void addRoute( string $alias, AbstractWindRoute $route, [boolean $default = false]  )

添加路由协议对象,如果添加的路由协议已经存在则抛出异常

Parameters:
AbstractWindRoute   $route: 
boolean   $default:  是否为默认
string   $alias: 

API Tags:
Access:  public

Information Tags:
Throws:  WindException

[ Top ]
assemble  [line 42]

  string assemble( string $action, [array $args = array()], [string $route = '']  )

创建Url,并返回构建好的Url值

Parameters:
string   $action:  操作信息
array   $args:  参数信息
string   $route:  路由协议别名

API Tags:
Abstract:  
Access:  public


Redefined in descendants as:

[ Top ]
getAction  [line 112]

  string getAction( )

返回action


API Tags:
Access:  public


[ Top ]
getActionKey  [line 176]

  string getActionKey( )


API Tags:
Access:  public


[ Top ]
getController  [line 121]

  string getController( )

返回controller


API Tags:
Access:  public


[ Top ]
getControllerKey  [line 169]

  string getControllerKey( )


API Tags:
Access:  public


[ Top ]
getDefaultAction  [line 224]

  string getDefaultAction( )

返回默认的action值


API Tags:
Access:  public


[ Top ]
getDefaultController  [line 215]

  string getDefaultController( )

返回默认的controller值


API Tags:
Access:  public


[ Top ]
getDefaultModule  [line 206]

  string getDefaultModule( )

返回默认的module值


API Tags:
Access:  public


[ Top ]
getModule  [line 148]

  string getModule( )


API Tags:
Access:  public


[ Top ]
getModuleKey  [line 162]

  string getModuleKey( )


API Tags:
Access:  public


[ Top ]
getRoute  [line 103]

  AbstractWindRoute getRoute( string $ruleName  )

根据rule的规则名称,从路由链中获得该路由的对象

Parameters:
string   $ruleName:  路由协议别名

API Tags:
Access:  public


[ Top ]
route  [line 32]

  string route( WindHttpRequest $request  )

路由解析

Parameters:
WindHttpRequest   $request: 

API Tags:
Abstract:  
Access:  public


Redefined in descendants as:

[ Top ]
setAction  [line 131]

  void setAction( string $action  )

设置action

Parameters:
string   $action: 

API Tags:
Access:  public


[ Top ]
setActionKey  [line 197]

  void setActionKey( string $actionKey  )

Parameters:
string   $actionKey: 

API Tags:
Access:  public


[ Top ]
setConfig  [line 47]

  void setConfig( $config  )

Parameters:
   $config: 

API Tags:
Access:  public


Redefinition of:
WindModule::setConfig()
设置类配置

Redefined in descendants as:

[ Top ]
setController  [line 141]

  void setController( string $controller  )

设置controller

Parameters:
string   $controller: 

API Tags:
Access:  public


[ Top ]
setControllerKey  [line 190]

  void setControllerKey( string $controllerKey  )

Parameters:
string   $controllerKey: 

API Tags:
Access:  public


[ Top ]
setModule  [line 155]

  void setModule( string $module  )

Parameters:
string   $module: 

API Tags:
Access:  public


[ Top ]
setModuleKey  [line 183]

  void setModuleKey( string $moduleKey  )

Parameters:
string   $moduleKey: 

API Tags:
Access:  public


[ Top ]
setParams  [line 72]

  void setParams( string $params, $request, WindHttpRequest $requeset  )

将路由解析到的url参数信息保存早系统变量中

Parameters:
string   $params: 
WindHttpRequest   $requeset: 
   $request: 

API Tags:
Access:  protected


Redefined in descendants as:

[ Top ]

Documentation generated on Fri, 30 Mar 2012 11:43:25 +0800 by phpDocumentor 1.4.4