CI框架 -- 建立類庫

當咱們使用 「類庫」 這個詞的時候，一般咱們指的是位於 libraries 這個目錄下的那些類。

接下來咱們將介紹 如何在 application/libraries 目錄下建立你本身的類庫，和全局的框架類庫獨立開來。

另外，若是你但願在現有的類庫中添加某些額外功能，CodeIgniter 容許你擴展原生的類， 或者你甚至能夠在你的 application/libraries 目錄下放置一個和原生的類庫同名的文件 徹底替代它。

總結起來：

• 你能夠建立一個全新的類庫，
• 你能夠擴展原生的類庫，
• 你能夠替換掉原生的類庫。

注：除了數據庫類不能被擴展或被你的類替換外，其餘的類均可以。

 

存儲位置

你的類庫文件應該放置在 application/libraries 目錄下，當你初始化類時，CodeIgniter 會在這個目錄下尋找這些類。

 

命名約定

• 文件名首字母必須大寫，例如：Myclass.php
• 類名定義首字母必須大寫，例如：class Myclass
• 類名和文件名必須一致

 

類文件

類應該定義成以下原型:

<?php
defined('BASEPATH') OR exit('No direct script access allowed');

class Someclass {

    public function some_method()
    {
    }
}

 

使用你的類

在你的 控制器 的任何方法中使用以下代碼初始化你的類:

$this->load->library('someclass');

其中，someclass 爲文件名，不包括 .php 文件擴展名。文件名能夠寫成首字母大寫， 也能夠寫成全小寫，CodeIgniter 均可以識別。

一旦加載，你就能夠使用小寫字母名稱來訪問你的類:

$this->someclass->some_method();

 

初始化類時傳入參數

在加載類庫的時候，你能夠經過第二個參數動態的傳遞一個數組數據，該數組將被傳到 你的類的構造函數中:

$params = array('type' => 'large', 'color' => 'red');

$this->load->library('someclass', $params);

若是你使用了該功能，你必須在定義類的構造函數時加上參數:

<?php defined('BASEPATH') OR exit('No direct script access allowed');

class Someclass {

    public function __construct($params)
    {
        // Do something with $params
    }
}

你也能夠將參數保存在配置文件中來傳遞，只需簡單的建立一個和類文件同名的配置文件， 並保存到你的 application/config/ 目錄下。要注意的是，若是你使用了上面介紹的方法 動態的傳遞參數，配置文件將不可用。

 

在你的類庫中使用 CodeIgniter 資源

在你的類庫中使用 get_instance() 函數來訪問 CodeIgniter 的原生資源，這個函數返回 CodeIgniter 超級對象。

一般狀況下，在你的控制器方法中你會使用 $this 來調用全部可用的 CodeIgniter 方法:

$this->load->helper('url');
$this->load->library('session');
$this->config->item('base_url');

可是 $this 只能在你的控制器、模型或視圖中直接使用，若是你想在你本身的類中使用 CodeIgniter 類，你能夠像下面這樣作：

首先，將 CodeIgniter 對象賦值給一個變量:

$CI =& get_instance();

一旦你把 CodeIgniter 對象賦值給一個變量以後，你就能夠使用這個變量來 代替 $this

$CI =& get_instance();

$CI->load->helper('url');
$CI->load->library('session');
$CI->config->item('base_url');

注：

上面的 get_instance() 函數經過引用來傳遞:

$CI =& get_instance();

這是很是重要的，引用賦值容許你使用原始的 CodeIgniter 對象，而不是建立一個副本。

既然類庫是一個類，那麼咱們最好充分的使用 OOP 原則，因此，爲了讓類中的全部方法都能使用 CodeIgniter 超級對象，建議將其賦值給一個屬性:

class Example_library {

    protected $CI;

    // We'll use a constructor, as you can't directly call a function
    // from a property definition.
    public function __construct()
    {
        // Assign the CodeIgniter super-object
        $this->CI =& get_instance();
    }

    public function foo()
    {
        $this->CI->load->helper('url');
        redirect();
    }

    public function bar()
    {
        echo $this->CI->config->item('base_url');
    }

}

 

使用你本身的類庫替換原生類庫

簡單的將你的類文件名改成和原生的類庫文件一致，CodeIgniter 就會使用它替換掉原生的類庫。 要使用該功能，你必須將你的類庫文件和類定義改爲和原生的類庫徹底同樣，例如， 要替換掉原生的 Email 類的話，你要新建一個 application/libraries/Email.php 文件， 而後定義定義你的類:

class CI_Email {

}

注意大多數原生類都以 CI_ 開頭。

要加載你的類庫，和標準的方法同樣:

$this->load->library('email');

注：

注意數據庫類不能被你本身的類替換掉。

 

擴展原生類庫

若是你只是想往現有的類庫中添加一些功能，例如增長一兩個方法， 這時替換整個類感受就有點殺雞用牛刀了。在這種狀況下，最好的方法是 擴展類庫。擴展一個類和替換一個類差很少，除了如下幾點：

• 類在定義時必須繼承自父類。
• 你的新類名和文件名必須以 MY_ 爲前綴（這個可配置，見下文）

例如，要擴展原生的 Email 類你須要新建一個文件命名爲 application/libraries/MY_Email.php ， 而後定義你的類:

class MY_Email extends CI_Email {

}

若是你須要在你的類中使用構造函數，確保你調用了父類的構造函數:

class MY_Email extends CI_Email {

    public function __construct($config = array())
    {
        parent::__construct($config);
    }

}

注：

並非全部的類庫構造函數的參數都是同樣的，在對類庫擴展以前 先看看它是怎麼實現的。

 

加載你的擴展類

要加載你的擴展類，仍是使用和一般同樣的語法。不用包含前綴。例如， 要加載上例中你擴展的 Email 類，你能夠使用:

$this->load->library('email');

一旦加載，你仍是和一般同樣使用類變量來訪問你擴展的類，以 email 類爲例， 訪問它的方法以下:

$this->email->some_method();

 

設置自定義前綴

要設置你本身的類的前綴，你能夠打開 application/config/config.php 文件， 找到下面這項:

$config['subclass_prefix'] = 'MY_';

注：全部原始的 CodeIgniter 類庫都以 CI_ 開頭，因此請不要使用這個 做爲你的自定義前綴。