本文主要介紹了PHP的Yii框架的組件化機制的基本知識,對應用程式CWebApplication元件進行了簡要剖析,需要的朋友可以參考下。
元件是 Yii 應用的主要基石。是 yii\base\Component 類別或其子類別的實例。三個用以區分它和其它類別的主要功能有:
屬性(Property)
use yii\jui\DatePicker; echo DatePicker::widget([ 'language' => 'zh-CN', 'name' => 'country', 'clientOptions' => [ 'dateFormat' => 'yy-mm-dd', ], ]);
永遠在你重寫的建構方法結尾處呼叫一下父類別的建構方法。
如果你重寫了 yii\base\Object::init() 方法,請確保你在 init 方法的開頭處呼叫了父類別的 init 方法。
範例如下:
namespace yii\components\MyClass; use yii\base\Object; class MyClass extends Object { public $prop1; public $prop2; public function __construct($param1, $param2, $config = []) { // ... 配置生效前的初始化过程 parent::__construct($config); } public function init() { parent::init(); // ... 配置生效后的初始化过程 } }
$component = new MyClass(1, 2, ['prop1' => 3, 'prop2' => 4]); // 方法二: $component = \Yii::createObject([ 'class' => MyClass::className(), 'prop1' => 3, 'prop2' => 4, ], [1, 2]);
yii\base\Object 類別執行時的生命週期如下:
透過 $config 配置物件。配置的過程可能會覆寫先前在構造方法內設定的預設值。
在 yii\base\Object::init() 方法內進行初始化後的收尾工作。你可以透過重寫此方法,進行一些良品檢驗,屬性的初始化之類的工作。
物件方法呼叫。
前三步都是在物件的建構方法內發生的。這意味著一旦你獲得了一個物件實例,那麼它就已經初始化就緒可供使用。
應用程式CWebApplication元件
在說明Yii中各個元件使用方法前,先了解最重要的一個元件CWebApplication。 CWebApplication即應用程式對象,它的根類別也是CComponent,故它也是一個元件,具有Yii元件的共同特徵。 具體來說,CWebApplication元件的主要作用是根據設定文件,載入必要的輔助元件,並在這些元件的幫助下(如urlManager)建立並執行控制器。故也稱為前端控制器。
我們可以在設定檔中指定CWebApplication元件本身的設定參數,這些參數被設定為其公共成員變量,或是自動呼叫setter方法設定屬性,這個特性可以在CWebApplication的建構子中發現:$this- >configure($config);
如在設定檔protected/config/main.php全域中指定:
'charset' => 'utf-8',
OK,在了解這個特性之後,我們就可以明白在設定檔中可以設定的屬性:
再例如,如果我们继承CWebApplication, 扩展自己的应用程序类myApp, 并定义方法setError_reporting(不区分大小写), 那么就可以直接在配置文件中指定error_reporting选项。
辅助组件可以将CWebApplication组件视为一部机器,那么辅助组件就可以视为组成这部机器的各个零件,没有零件的正确组合,机器就无法正常工作,这在Yii中也是同样的概念。而一些组件对整部机器的运转是必须的,这就是核心组件。在应用程序对象构造后,Yii会将辅助组件基本信息进行登记(组件名称与类名,属性配置的对照表),以供后续使用,对web应用程序而言,存在以下核心组件(通过CWebApplication::registerCoreComponents,CApplication::registerCoreComponents注册):
CWebApplication::registerCoreComponents中注册的核心组件
CApplication::registerCoreComponents中注册的核心组件
配置文本中注册的核心组件:log CLogRouter 日志路由管理器
以上标记为红色的条目,是最重要的辅助组件,其它的核心组件我们未必会使用到。
如何定义辅助组件的属性?通过在配置文件protected/config/main.php中设置components项的值,实现组件属性定义。这里的定义主要是三个要素:指定组件的名称(核心组件已经预先设置)、指定组件使用的类(核心组件无须定义),组件的属性(可选、视情况而定)
如以下配置:
'components' => array( 'db' => array( 'class' => 'myCDbConnection', 'connnectionString' => 'mysql:host=localhost;dbname=test;charset=utf8', 'user' => 'root', ), );
就设置了db组件使用的类为myCDbConnection, 并且在后面指定了连接串及账号等信息。提示: myCDbConnection类可能就是通过继承CDbConnection类定义。核心组件无须指定class参数(因为已经预先定义好)
问题:如何得知某个组件可配置的属性?这个问题至关重要,如果我们掌握了规律,就可以举一反三,所有组件的配置均可以灵活设定。授之以鱼不如授之以渔。在本节会说明通用的方法。要得知组件的所有可定义属性,按以下步骤进行:
1. 组件所使用的类是什么?(无论是核心组件还是自定义组件)
2. 组件类的公共成员变量都有哪些?(注意从父类继承而来的公共成员变量)
3. 组件类都有哪些settter方法?(注意从父类继承而来的方法)
明白了以上三个要点,我们就可以按规律定义组件的属性,比如对最重要的db组件,我们发现这是一个核心组件,使用的类为CDbConnection, 我们查阅这个类的定义文件,发现这个类的公共成员变量有:
$connectionString;
$username='';
$password='';
$autoConnect=true;
$charset;
$emulatePrepare;
$tablePrefix;
$initSQLs;
... ...
setter方法定义的属性:
setActive($value)
setAttributes($values)
setAutoCommit($value)
setColumnCase($value)
setNullConversion($value)
setPersistent($value)
提示:setter方法定义的属性名称不区分大小写以上所列的属性,均可以在配置文件中指定,具体每个属性的作用,请参阅Yii类文件的详细注释(Yii代码的注释也是相当棒,通俗易懂,而又很详细)
再来一个例子,定义urlManager组件的属性这个组件使用的类为CUrlManager, 我们查阅它的属性:
$rules=array();
$urlSuffix='';
$showScriptName=true;
$appendParams=true;
$routeVar='r';
$caseSensitive=true;
通过setter方法定义的属性:
setUrlFormat($value)
setBaseUrl($value)
即urlManager组件的上述属性可以在配置文件中定义(每项配置的作用请参阅其注释)。其它组件的配置均可按上述方法处理。
如何使用组件应用程序运行后,会将所有已经定义过的组件注册(并未实例化)到CWebApplication对象上,同时CWebApplication应用程序对象会被注册到Yii::$_app,在程序的任何位置均可通过Yii::app()得到当前应用程序对象引用,再通过$app对象得到组件实例引用,如:Yii::app()->getComponent('urlManager'); #会查找组件配置并实例化之Yii::app()->urlManager; #通过CModule::__get()魔术方法实现
如何自定义组件?这是很常见的需求,比如我们可能希望db组件(数据库连接)使用我们自定义的类,也或者我们希望使用多个数据库连接,这种情况下就需要自定义组件,使用多数据库的例子:
components=>array( 'db' => array( ... ... ), 'mydb'=>array( 'class' => 'myDbConnection', 'connectionString' => 'mysql:host=localhost;dbname=test;charset=utf8', 'tablePrefix' => 'cdb_', 'username' => 'root', ), ), 修改默认的db组件所使用的类: components=>array( 'db' => array( 'class' => 'myDbConnection', ... ... ), ),
相关推荐:
以上是淺析Yii框架的組件化機制的詳細內容。更多資訊請關注PHP中文網其他相關文章!