Qiang Xue
12 years ago
17 changed files with 69 additions and 238 deletions
@ -1,90 +0,0 @@
|
||||
<?php |
||||
/** |
||||
* ActionFilter class file. |
||||
* |
||||
* @link http://www.yiiframework.com/ |
||||
* @copyright Copyright © 2008 Yii Software LLC |
||||
* @license http://www.yiiframework.com/license/ |
||||
*/ |
||||
|
||||
namespace yii\base; |
||||
|
||||
/** |
||||
* ActionFilter is the base class for all action filters. |
||||
* |
||||
* A filter can be applied to a controller action at different stages of its life cycle. In particular, |
||||
* it responds to the following events that are raised when an action is being executed: |
||||
* |
||||
* 1. authorize |
||||
* 2. beforeAction |
||||
* 3. beforeRender |
||||
* 4. afterRender |
||||
* 5. afterAction |
||||
* |
||||
* Derived classes may respond to these events by overriding the corresponding methods in this class. |
||||
* For example, to create an access control filter, one may override the [[authorize()]] method. |
||||
* |
||||
* @author Qiang Xue <qiang.xue@gmail.com> |
||||
* @since 2.0 |
||||
*/ |
||||
class ActionFilter extends Behavior |
||||
{ |
||||
/** |
||||
* @var Controller the owner of this behavior. For action filters, this should be a controller object. |
||||
*/ |
||||
public $owner; |
||||
/** |
||||
* @var array IDs of actions that this filter applies to. |
||||
* If this property is empty or not set, it means this filter applies to all actions. |
||||
* Note that if an action appears in [[except]], the filter will not apply to this action, even |
||||
* if the action also appears in [[only]]. |
||||
* @see exception |
||||
*/ |
||||
public $only; |
||||
/** |
||||
* @var array IDs of actions that this filter does NOT apply to. |
||||
*/ |
||||
public $except; |
||||
|
||||
public function init() |
||||
{ |
||||
$this->owner->on('authorize', array($this, 'handleEvent')); |
||||
$this->owner->on('beforeAction', array($this, 'handleEvent')); |
||||
$this->owner->on('beforeRender', array($this, 'handleEvent')); |
||||
$this->owner->getEventHandlers('afterRender')->insertAt(0, array($this, 'handleEvent')); |
||||
$this->owner->getEventHandlers('afterAction')->insertAt(0, array($this, 'handleEvent')); |
||||
} |
||||
|
||||
public function authorize($event) |
||||
{ |
||||
} |
||||
|
||||
public function beforeAction($event) |
||||
{ |
||||
} |
||||
|
||||
public function beforeRender($event) |
||||
{ |
||||
} |
||||
|
||||
public function afterRender($event) |
||||
{ |
||||
} |
||||
|
||||
public function afterAction($event) |
||||
{ |
||||
} |
||||
|
||||
public function handleEvent($event) |
||||
{ |
||||
if ($this->applyTo($event->action)) { |
||||
$this->{$event->name}($event); |
||||
} |
||||
} |
||||
|
||||
public function applyTo(Action $action) |
||||
{ |
||||
return (empty($this->only) || in_array($action->id, $this->only, false) !== false) |
||||
&& (empty($this->except) || in_array($action->id, $this->except, false) === false); |
||||
} |
||||
} |
||||
@ -1,103 +0,0 @@
|
||||
<?php |
||||
/** |
||||
* ReflectionHelper class file. |
||||
* |
||||
* @link http://www.yiiframework.com/ |
||||
* @copyright Copyright © 2008 Yii Software LLC |
||||
* @license http://www.yiiframework.com/license/ |
||||
*/ |
||||
|
||||
namespace yii\util; |
||||
|
||||
use yii\base\Exception; |
||||
|
||||
/** |
||||
* ReflectionHelper |
||||
* |
||||
* @author Qiang Xue <qiang.xue@gmail.com> |
||||
* @since 2.0 |
||||
*/ |
||||
class ReflectionHelper |
||||
{ |
||||
/** |
||||
* Prepares parameters so that they can be bound to the specified method. |
||||
* This method converts the input parameters into an array that can later be |
||||
* passed to `call_user_func_array()` when calling the specified method. |
||||
* The conversion is based on the matching of method parameter names |
||||
* and the input array keys. For example, |
||||
* |
||||
* ~~~ |
||||
* class Foo { |
||||
* function bar($a, $b) { ... } |
||||
* } |
||||
* $object = new Foo; |
||||
* $params = array('b' => 2, 'c' => 3, 'a' => 1); |
||||
* var_export(ReflectionHelper::extractMethodParams($object, 'bar', $params)); |
||||
* // output: array('a' => 1, 'b' => 2); |
||||
* ~~~ |
||||
* |
||||
* @param object|string $object the object or class name that owns the specified method |
||||
* @param string $method the method name |
||||
* @param array $params the parameters in terms of name-value pairs |
||||
* @return array parameters that are needed by the method only and |
||||
* can be passed to the method via `call_user_func_array()`. |
||||
* @throws Exception if any required method parameter is not found in the given parameters |
||||
*/ |
||||
public static function extractMethodParams($object, $method, $params) |
||||
{ |
||||
$m = new \ReflectionMethod($object, $method); |
||||
$ps = array(); |
||||
foreach ($m->getParameters() as $param) { |
||||
$name = $param->getName(); |
||||
if (array_key_exists($name, $params)) { |
||||
$ps[$name] = $params[$name]; |
||||
} elseif ($param->isDefaultValueAvailable()) { |
||||
$ps[$name] = $param->getDefaultValue(); |
||||
} else { |
||||
throw new Exception(\Yii::t('yii', 'Missing required parameter "{name}".', array('{name}' => $name))); |
||||
} |
||||
} |
||||
return $ps; |
||||
} |
||||
|
||||
/** |
||||
* Initializes an object with the given parameters. |
||||
* Only the public non-static properties of the object will be initialized, and their names must |
||||
* match the given parameter names. For example, |
||||
* |
||||
* ~~~ |
||||
* class Foo { |
||||
* public $a; |
||||
* protected $b; |
||||
* } |
||||
* $object = new Foo; |
||||
* $params = array('b' => 2, 'c' => 3, 'a' => 1); |
||||
* $remaining = ReflectionHelper::bindObjectParams($object, $params); |
||||
* var_export($object); // output: $object->a = 1; $object->b = null; |
||||
* var_export($remaining); // output: array('b' => 2, 'c' => 3); |
||||
* ~~~ |
||||
* |
||||
* @param object $object the object whose properties are to be initialized |
||||
* @param array $params the input parameters to be used to initialize the object |
||||
* @return array the remaining unused input parameters |
||||
*/ |
||||
public static function initObjectWithParams($object, $params) |
||||
{ |
||||
if (empty($params)) { |
||||
return array(); |
||||
} |
||||
|
||||
$class = new \ReflectionClass(get_class($object)); |
||||
foreach ($params as $name => $value) { |
||||
if ($class->hasProperty($name)) { |
||||
$property = $class->getProperty($name); |
||||
if ($property->isPublic() && !$property->isStatic()) { |
||||
$object->$name = $value; |
||||
unset($params[$name]); |
||||
} |
||||
} |
||||
} |
||||
|
||||
return $params; |
||||
} |
||||
} |
||||
Loading…
Reference in new issue