1. Yii PHP 框架分析（二） 
  2. 作者：wdy 
  3.  
  4. http://hi.baidu.com/delphiss/blog/item/54597af595085ad3f3d38552.html 
  5.  
  6. Yii是基于组件（component-based）的 web框架，CComponent类是所有组件的基类。 
  7.  
  8. CComponent类为子类提供了基于属性 (property)、事件(event)、行为(behavior)编程接口。 
  9.  
  10. 组件的属性(property) 
  11.  
  12. Ccomponent类并没有提供属性的变量存储，需要由子类来提供两个方法来实现。子类的getPropertyName()方法提供$component->PropertyName的取值操作数据，子类的setPropertyName($val)方法提供$component->PropertyName赋值操作。 
  13.  
  14. $width=$component->textWidth;     // 获取 textWidth 属性 
  15.  
  16. 实现方式为调用子类提供的方法 $width=$component->getTextWidth() 
  17.  
  18. $component->textWidth=$width;     // 设置 textWidth 属性 
  19.  
  20. 实现方式为调用子类提供的方法 $component->setTextWidth($width) 
  21.  
  22. public function getTextWidth() 
  23. { 
  24.     return $this->_textWidth; 
  25. } 
  26.  
  27. public function setTextWidth($value) 
  28. { 
  29.     $this->_textWidth=$value; 
  30. } 
  31.  
  32. 组件的属性值是大小写不敏感的（类的成员时大小写敏感的） 
  33.  
  34. 组件的事件（event） 
  35.  
  36. 组件事件是一种特殊的属性，它可以将事件处理句柄（可以是函数名、类方法或对象方法）注册（绑定）到一个事件名上，句柄在事件被唤起的时候被自动调用。 
  37. 组件事件存放在CComponent 的$_e[]数组里，数组的键值为事件的名字，键值的数值为一个Clist对象，Clist是Yii提供的一个队列容器，Clist的方法add()添加事件的回调handle。 
  38.  
  39. //添加一个全局函数到事件处理 
  40. $component-> onBeginRequest=”logRequest”; 
  41. //添加一个类静态方法到事件处理 
  42. $component-> onBeginRequest=array(“CLog”,” logRequest”); 
  43. //添加一个对象方法到事件处理 
  44. $component-> onBeginRequest=array($mylog,” logRequest”); 
  45.  
  46. 唤起事件： 
  47. $component ->raiseEvent('onBeginRequest ', $event); 
  48. 会自动调用: 
  49. logRequest($event), Clog:: logRequest($event)和$mylog.logRequest($event) 
  50.  
  51. 事件句柄必须按照如下来定义 : 
  52. function methodName($event) 
  53. { 
  54.     ...... 
  55. } 
  56. $event 参数是 CEvent 或其子类的实例，它至少包含了"是谁挂起了这个事件"的信息。 
  57.  
  58. 事件的名字以”on”开头，在__get()和 __set()里可以通过这个来区别属性和事件。 
  59.  
  60. 组件行为（behavior） 
  61.  
  62. 组件的行为是一种不通过继承而扩展组件功能的方法（参见设计模式里的策略模式）。 
  63.  
  64. 行为类必须实现 IBehavior 接口，大多数行为可以从 CBehavior 基类扩展而来。 
  65.  
  66. IBehavior接口提供了4个方法。 
  67. attach($component)将自身关联到组件，detach($component) 解除$component关联，getEnabled()和setEnabled()设置行为对象的有效性。 
  68.  
  69. 行为对象存放在组件的$_m[]数组里，数组键值为行为名字符串，数组值为行为类对象。 
  70.  
  71. 组件通过attachBehavior ($name,$behavior)来扩展一个行为： 
  72. $component-> attachBehavior (‘render’,$htmlRender) 
  73. 为$component添加了一个名字为render的行为，$htmlRender 需是一个实现 IBehavior 接口的对象，或是一个数组： 
  74. array( 'class'=>'path.to.BehaviorClass', 
  75.    'property1'=>'value1', 
  76.    'property2'=>'value2', 
  77.    * ) 
  78. 会根据数组的class来创建行为对象并设置属性值。 
  79.  
  80. $htmlRender被存储到$_m[‘render’]中。 
  81.  
  82. 外部调用一个组件未定义的方法时，魔术方法__call() 会遍历所有行为对象，如果找到同名方法就调用之。 
  83.  
  84.   
  85.  
  86. 例如 $htmlRender 有个方法 renderFromFile()，则可以直接当做组件的方法来访问： 
  87.  
  88. $component-> renderFromFile () 
  89.  
  90.   
  91.  
  92. CComponent源码分析 
  93.  
  94. //所有部件的基类 
  95. class CComponent 
  96. { 
  97. private $_e; 
  98. private $_m; 
  99.  
  100. //获取部件属性、事件和行为的magic method 
  101. public function __get($name) 
  102. { 
  103.    $getter='get'.$name; 
  104.    //是否存在属性的get方法 
  105.    if(method_exists($this,$getter)) 
  106.     return $this->$getter(); 
  107.    //以on开头，获取事件处理句柄 
  108.    else if(strncasecmp($name,'on',2)===0 && method_exists($this,$name)) 
  109.    { 
  110.     // 事件名小写 
  111.     $name=strtolower($name); 
  112.     // 如果_e[$name] 不存在，返回一个空的CList事件句柄队列对象 
  113.     if(!isset($this->_e[$name])) 
  114.      $this->_e[$name]=new CList; 
  115.     // 返回_e[$name]里存放的句柄队列对象 
  116.     return $this->_e[$name]; 
  117.    } 
  118.    // _m[$name] 里存放着行为对象则返回 
  119.    else if(isset($this->_m[$name])) 
  120.     return $this->_m[$name]; 
  121.    else 
  122.     throw new CException(Yii::t('yii','Property "{class}.{property}" is not defined.', 
  123.      array('{class}'=>get_class($this), '{property}'=>$name))); 
  124. } 
  125.  
  126. /** 
  127. * PHP magic method 
  128. * 设置组件的属性和事件 
  129. */ 
  130. public function __set($name,$value) 
  131. { 
  132.    $setter='set'.$name; 
  133.    //是否存在属性的set方法 
  134.    if(method_exists($this,$setter)) 
  135.     $this->$setter($value); 
  136.    //name以on开头，这是事件处理句柄 
  137.    else if(strncasecmp($name,'on',2)===0 && method_exists($this,$name)) 
  138.    { 
  139.     // 事件名小写 
  140.     $name=strtolower($name); 
  141.     // _e[$name] 不存在则创建一个CList对象 
  142.     if(!isset($this->_e[$name])) 
  143.      $this->_e[$name]=new CList; 
  144.     // 添加事件处理句柄 
  145.     $this->_e[$name]->add($value); 
  146.    } 
  147.    // 属性没有set方法，只有get方法，为只读属性，抛出异常 
  148.    else if(method_exists($this,'get'.$name)) 
  149.     throw new CException(Yii::t('yii','Property "{class}.{property}" is read only.', 
  150.      array('{class}'=>get_class($this), '{property}'=>$name))); 
  151.    else 
  152.     throw new CException(Yii::t('yii','Property "{class}.{property}" is not defined.', 
  153.      array('{class}'=>get_class($this), '{property}'=>$name))); 
  154. } 
  155.  
  156. /** 
  157. * PHP magic method 
  158. * 为isset()函数提供是否存在属性和事件处理句柄的判断 
  159. */ 
  160. public function __isset($name) 
  161. { 
  162.    $getter='get'.$name; 
  163.    if(method_exists($this,$getter)) 
  164.     return $this->$getter()!==null; 
  165.    else if(strncasecmp($name,'on',2)===0 && method_exists($this,$name)) 
  166.    { 
  167.     $name=strtolower($name); 
  168.     return isset($this->_e[$name]) && $this->_e[$name]->getCount(); 
  169.    } 
  170.    else 
  171.     return false; 
  172. } 
  173.  
  174. /** 
  175. * PHP magic method 
  176. * 设置属性值为空或删除事件名字对应的处理句柄 
  177. */ 
  178. public function __unset($name) 
  179. { 
  180.    $setter='set'.$name; 
  181.    if(method_exists($this,$setter)) 
  182.     $this->$setter(null); 
  183.    else if(strncasecmp($name,'on',2)===0 && method_exists($this,$name)) 
  184.     unset($this->_e[strtolower($name)]); 
  185.    else if(method_exists($this,'get'.$name)) 
  186.     throw new CException(Yii::t('yii','Property "{class}.{property}" is read only.', 
  187.      array('{class}'=>get_class($this), '{property}'=>$name))); 
  188. } 
  189.  
  190.   
  191.  
  192. /** 
  193. * PHP magic method 
  194. * CComponent未定义的类方法，寻找行为类里的同名方法，实现行为方法的调用 
  195. */ 
  196. public function __call($name,$parameters) 
  197. { 
  198.    // 行为类存放的$_m数组不空 
  199.    if($this->_m!==null) 
  200.    { 
  201.     // 循环取出$_m数组里存放的行为类 
  202.     foreach($this->_m as $object) 
  203.     { 
  204.      // 行为类对象有效，并且方法存在，调用之 
  205.      if($object->enabled && method_exists($object,$name)) 
  206.       return call_user_func_array(array($object,$name),$parameters); 
  207.     } 
  208.    } 
  209.    throw new CException(Yii::t('yii','{class} does not have a method named "{name}".', 
  210.     array('{class}'=>get_class($this), '{name}'=>$name))); 
  211. } 
  212.  
  213. /** 
  214. * 根据行为名返回行为类对象 
  215. */ 
  216. public function asa($behavior) 
  217. { 
  218.    return isset($this->_m[$behavior]) ? $this->_m[$behavior] : null; 
  219. } 
  220.  
  221. /** 
  222. * Attaches a list of behaviors to the component. 
  223. * Each behavior is indexed by its name and should be an instance of 
  224. * {@link IBehavior}, a string specifying the behavior class, or an 
  225. * array of the following structure: 
  226. * <pre> 
  227. * array( 
  228. *     'class'=>'path.to.BehaviorClass', 
  229. *     'property1'=>'value1', 
  230. *     'property2'=>'value2', 
  231. * ) 
  232. * </pre> 
  233. * @param array list of behaviors to be attached to the component 
  234. * @since 1.0.2 
  235. */ 
  236. public function attachBehaviors($behaviors) 
  237. { 
  238.    // $behaviors为数组 $name=>$behavior 
  239.    foreach($behaviors as $name=>$behavior) 
  240.     $this->attachBehavior($name,$behavior); 
  241. } 
  242.  
  243.  
  244. /** 
  245. * 添加一个行为到组件 
  246. */ 
  247. public function attachBehavior($name,$behavior) 
  248. { 
  249.    /* $behavior不是IBehavior接口的实例，则为 
  250.    * array( 
  251.    *     'class'=>'path.to.BehaviorClass', 
  252.    *     'property1'=>'value1', 
  253.    *     'property2'=>'value2', 
  254.    * ) 
  255.    * 传递给Yii::createComponent创建行为了并初始化对象属性 
  256.    */ 
  257.    if(!($behavior instanceof IBehavior)) 
  258.     $behavior=Yii::createComponent($behavior); 
  259.    $behavior->setEnabled(true); 
  260.    $behavior->attach($this); 
  261.    return $this->_m[$name]=$behavior; 
  262. } 
  263.  
  264. /** 
  265. * Raises an event. 
  266. * This method represents the happening of an event. It invokes 
  267. * all attached handlers for the event. 
  268. * @param string the event name 
  269. * @param CEvent the event parameter 
  270. * @throws CException if the event is undefined or an event handler is invalid. 
  271. */ 
  272. public function raiseEvent($name,$event) 
  273. { 
  274.    $name=strtolower($name); 
  275.    // _e[$name] 事件处理句柄队列存在 
  276.    if(isset($this->_e[$name])) 
  277.    { 
  278.      // 循环取出事件处理句柄 
  279.     foreach($this->_e[$name] as $handler) 
  280.     { 
  281.      // 事件处理句柄为全局函数 
  282.      if(is_string($handler)) 
  283.       call_user_func($handler,$event); 
  284.      else if(is_callable($handler,true)) 
  285.      { 
  286.       // an array: 0 - object, 1 - method name 
  287.       list($object,$method)=$handler; 
  288.       if(is_string($object)) // 静态类方法 
  289.        call_user_func($handler,$event); 
  290.       else if(method_exists($object,$method)) 
  291.        $object->$method($event); 
  292.       else 
  293.        throw new CException(Yii::t('yii','Event "{class}.{event}" is attached with an invalid handler "{handler}".', 
  294.         array('{class}'=>get_class($this), '{event}'=>$name, '{handler}'=>$handler[1]))); 
  295.      } 
  296.      else 
  297.       throw new CException(Yii::t('yii','Event "{class}.{event}" is attached with an invalid handler "{handler}".', 
  298.        array('{class}'=>get_class($this), '{event}'=>$name, '{handler}'=>gettype($handler)))); 
  299.     // $event 的handled 设置为true后停止队列里剩余句柄的调用 
  300.     if(($event instanceof CEvent) && $event->handled) 
  301.       return; 
  302.     } 
  303.    } 
  304.    else if(YII_DEBUG && !$this->hasEvent($name)) 
  305.     throw new CException(Yii::t('yii','Event "{class}.{event}" is not defined.', 
  306.      array('{class}'=>get_class($this), '{event}'=>$name))); 
  307. } 
  308. }