Class: WindActionFilter

Source Location: /filter/WindActionFilter.php

Class WindActionFilter

Class Overview

action拦截器父类

继承实现拦截链preHandle（前置）和postHandle（后置）职责.将实现的拦截链添加到应用配置中,使之生效: 例如实现MyFilter,则需要在应用配置中添加如下配置:

'filters' => array(
'class' => 'WIND:filter.WindFilterChain', //设置使用的拦截链实现
'filter1' => array(
'class' => 'MYAPP:filter.MyFilter', //设置设置实现的MyFilter类路径,MYAPP必须是一个有效的经过注册的命名空间
'pattern' => '*', //此处设置该拦截规则应用的范围,*意味着所有的action都将会应用该拦截规则
)
)

关于pattern的设置说明如下：

*：则所有的请求都将会应用该拦截器
moduleA*: 则所有配置的moduleA模块下的请求都将会应用该拦截器
moduleA_index*: 则moduleA模块下的indexController下的所有Action请求都将会应用该拦截器
moduleA_index_add*: 则module模块下的indexController下的addAction将会应用该拦截器

用户可以在filter中添加自己的特殊配置:比如:

'filters' => array(
'class' => 'WIND:filter.WindFilterChain',
'filter1' => array(
'class' => 'MYAPP:filter.TestFilter',
'pattern' => '*',
'isOpen' => '1', //添加的配置
)
)

则在自己的TestFilter中设置一个属性名为isOpen同时设置该属性为protected权限,那么在使用的时候该配置的值将会赋值给该属性.

Located in /filter/WindActionFilter.php [line 43]

WindModule
   |
   --WindHandlerInterceptor
      |
      --WindActionFilter

Author(s):

Qiong Wu <papa0924@gmail.com>

API Tags:

Abstract:

Information Tags:

Version:	$Id: WindActionFilter.php 2973 2011-10-15 19:22:48Z yishuo $
Copyright:	©2003-2103 phpwind.com
License:	http://www.windframework.com

Properties

Methods

[ Top ]

Descendants

Child Class	Description
WindFormFilter	form表单拦截器

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From WindHandlerInterceptor

WindHandlerInterceptor::$interceptorChain

WindHandlerInterceptor::$result

Inherited From WindModule

WindModule::$_config

WindModule::$_proxy

WindModule::$_typeValidation

Inherited From WindHandlerInterceptor

WindHandlerInterceptor::handle()

拦截器的执行入口

WindHandlerInterceptor::postHandle()

拦截器的后置操作

WindHandlerInterceptor::preHandle()

拦截器的前置操作

WindHandlerInterceptor::setHandlerInterceptorChain()

设置拦截链对象

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

WindErrorMessage	$errorMessage	错误处理类
WindForward	$forward	action跳转类
AbstractWindRouter	$router	路由对象

[ Top ]

Method Summary

WindActionFilter	__construct()	构造函数
array\|string	getInput()	从指定源中根据输入的参数名获得输入数据
void	setGlobal()	设置全局模板数据
void	setOutput()	设置模板数据

[ Top ]

Properties

WindErrorMessage $errorMessage = null [line 55]

错误处理类

API Tags:

Access:

protected

[ Top ]

WindForward $forward = null [line 49]

action跳转类

API Tags:

Access:

protected

[ Top ]

AbstractWindRouter $router = null [line 61]

路由对象

API Tags:

Access:

protected

[ Top ]

Methods

Constructor __construct [line 73]

WindActionFilter __construct(
WindForward
$forward, WindErrorMessage
$errorMessage, AbstractWindRouter
$router, [array
$args = array()] 
)

构造函数

初始化类属性

Parameters:

WindForward	$forward:	设置当前的forward对象
WindErrorMessage	$errorMessage:	设置错误处理的errorMessage
AbstractWindRouter	$router:	路由对象
array	$args:	接受数组传递,数组以关联数组的方式给出,如果存在属性和关联数组中的key相同则将该key对应值设置给该属性.

API Tags:

Access:

public

[ Top ]

getInput [line 124]

array|string getInput(
string
$name, [string
$type = ''], [string
$callback = array()] 
)

从指定源中根据输入的参数名获得输入数据

Parameters:

string	$name:	需要获取的值的key
string	$type:	获取数据源,可以是(GET POST COOKIE)中的一个,每种都将从各自的源中去获取对应的数值: GET: 将从$_GET中去获取数据 POST: 将从$_POST中去获取数据 COOKIE: 将从$_COOKIE中去获取数据其他值: 将依次从request对象的attribute,$_GET,$_POST,$_COOKIE,$_REQUEST,$_ENV,$_SERVER中去尝试获取该值. 该参数默认为空
string	$callback:	回调函数,缺省值为空数组,该回调函数支持数组格式,即可以是调用类中的方法

API Tags:

Return:	当有$callback的时候返回一个数组，其有两个元素：第一个元素: 获得的用户输入的值第二个元素：执行$callback之后返回的值
Access:	protected

[ Top ]

setGlobal [line 101]

void setGlobal(
string|array|object 
$data, [string
$key = ''] 
)

设置全局模板数据

设置为Global的参数数据,将可以在所有子模板中共用,在模板中的通过{@G:varName}的方式去获取变量

Parameters:

string\|array\|object	$data:	需要设置的数据
string	$key:	参数的名字,默认为空，如果key为空，并且$data是数组或是对象的时候，则$data中的元素将会作为单独的参数保存到Global数据中.

API Tags:

Access:

protected

[ Top ]

setOutput [line 89]

void setOutput(
string|array|object 
$data, [string
$key = ''] 
)

设置模板数据

此方法设置的参数,作用域仅仅只是在当前模板中可用,调用的方法为{$varName}

Parameters:

string\|array\|object	$data:	需要设置输出的参数
string	$key:	参数的名字,默认为空，如果key为空，并且$data是数组或是对象的时候，则$data中的元素将会作为单独的参数保存到输出数据中.

API Tags:

Access:

protected

[ Top ]

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

	filter

[ class tree: filter ] [ index: filter ] [ all elements ]