CodeIgniter 創(chuàng)建類庫

創(chuàng)建類庫

當(dāng)我們使用 “類庫” 這個詞的時候，通常我們指的是位于 libraries 這個目錄下的那些類， 在我們這份用戶手冊的類庫參考部分有詳細的介紹。但是在這篇文章中，我們將介紹 如何在 application/libraries 目錄下創(chuàng)建你自己的類庫，和全局的框架類庫獨立開來。

另外，如果你希望在現(xiàn)有的類庫中添加某些額外功能，CodeIgniter 允許你擴展原生的類， 或者你甚至可以在你的 application/libraries 目錄下放置一個和原生的類庫同名的文件 完全替代它。

總結(jié)起來：

• 你可以創(chuàng)建一個全新的類庫，
• 你可以擴展原生的類庫，
• 你可以替換掉原生的類庫。

下面將詳細講述這三點。

注解
除了數(shù)據(jù)庫類不能被擴展或被你的類替換外，其他的類都可以。

存儲位置

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

命名約定

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

類文件

類應(yīng)該定義成如下原型:

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

class Someclass {

    public function some_method()
    {
    }
}

注解
這里的 Someclass 名字只是個例子。

使用你的類

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

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

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

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

$this->someclass->some_method();  // Object instances will always be lower case

初始化類時傳入?yún)?shù)

在加載類庫的時候，你可以通過第二個參數(shù)動態(tài)的傳遞一個數(shù)組數(shù)據(jù)，該數(shù)組將被傳到 你的類的構(gòu)造函數(shù)中:

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

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

如果你使用了該功能，你必須在定義類的構(gòu)造函數(shù)時加上參數(shù):

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

class Someclass {

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

你也可以將參數(shù)保存在配置文件中來傳遞，只需簡單的創(chuàng)建一個和類文件同名的配置文件， 并保存到你的 application/config/ 目錄下。要注意的是，如果你使用了上面介紹的方法 動態(tài)的傳遞參數(shù)，配置文件將不可用。

在你的類庫中使用 CodeIgniter 資源

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

通常情況下，在你的控制器方法中你會使用 $this 來調(diào)用所有可用的 CodeIgniter 方法:

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

但是 $this 只能在你的控制器、模型或視圖中直接使用，如果你想在你自己的類中使用 CodeIgniter 類，你可以像下面這樣做：

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

$CI =& get_instance();

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

$CI =& get_instance();

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

注解

你會看到上面的 get_instance() 函數(shù)通過引用來傳遞:

$CI =& get_instance();

這是非常重要的，引用賦值允許你使用原始的 CodeIgniter 對象，而不是創(chuàng)建一個副本。

既然類庫是一個類，那么我們最好充分的使用 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 {

}

注意大多數(shù)原生類都以 CI_ 開頭。

要加載你的類庫，和標(biāo)準(zhǔn)的方法一樣:

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

注解

注意數(shù)據(jù)庫類不能被你自己的類替換掉。

擴展原生類庫

如果你只是想往現(xiàn)有的類庫中添加一些功能，譬如增加一兩個方法， 這時替換整個類感覺就有點殺雞用牛刀了。在這種情況下，最好的方法是 擴展類庫。擴展一個類和替換一個類差不多，除了以下幾點：

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

例如，要擴展原生的 Email 類你需要新建一個文件命名為 application/libraries/MY_Email.php ， 然后定義你的類:

class MY_Email extends CI_Email {

}

如果你需要在你的類中使用構(gòu)造函數(shù)，確保你調(diào)用了父類的構(gòu)造函數(shù):

class MY_Email extends CI_Email {

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

}

注解

并不是所有的類庫構(gòu)造函數(shù)的參數(shù)都是一樣的，在對類庫擴展之前 先看看它是怎么實現(xiàn)的。

加載你的擴展類

要加載你的擴展類，還是使用和通常一樣的語法。不用包含前綴。例如， 要加載上例中你擴展的 Email 類，你可以使用:

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

一旦加載，你還是和通常一樣使用類變量來訪問你擴展的類，以 email 類為例， 訪問它的方法如下:

$this->email->some_method();

設(shè)置自定義前綴

要設(shè)置你自己的類的前綴，你可以打開 application/config/config.php 文件， 找到下面這項:

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

請注意所有原始的 CodeIgniter 類庫都以 CI_ 開頭，所以請不要使用這個 作為你的自定義前綴。