# 創建類庫
當我們使用 “類庫” 這個詞的時候,通常我們指的是位于 libraries 這個目錄下的那些類, 在我們這份用戶手冊的類庫參考部分有詳細的介紹。但是在這篇文章中,我們將介紹 如何在 application/libraries 目錄下創建你自己的類庫,和全局的框架類庫獨立開來。
另外,如果你希望在現有的類庫中添加某些額外功能,CodeIgniter 允許你擴展原生的類, 或者你甚至可以在你的?application/libraries?目錄下放置一個和原生的類庫同名的文件 完全替代它。
總結起來:
* 你可以創建一個全新的類庫,
* 你可以擴展原生的類庫,
* 你可以替換掉原生的類庫。
下面將詳細講述這三點。
>[info] 注解
> 除了數據庫類不能被擴展或被你的類替換外,其他的類都可以。
## 存儲位置
你的類庫文件應該放置在?application/libraries?目錄下,當你初始化類時,CodeIgniter 會在這個目錄下尋找這些類。
## 命名約定
* 文件名首字母必須大寫,例如:Myclass.php
* 類名定義首字母必須大寫,例如:class Myclass
* 類名和文件名必須一致
## 類文件
類應該定義成如下原型:
~~~
<?php
defined('BASEPATH') OR exit('No direct script access allowed');
class Someclass {
public function some_method()
{
}
}
~~~
>[info] 注解
> 這里的 Someclass 名字只是個例子。
## 使用你的類
在你的?[控制器](http://codeigniter.org.cn/user_guide/general/controllers.html)?的任何方法中使用如下代碼初始化你的類:
~~~
$this->load->library('someclass');
~~~
其中,someclass?為文件名,不包括 .php 文件擴展名。文件名可以寫成首字母大寫, 也可以寫成全小寫,CodeIgniter 都可以識別。
一旦加載,你就可以使用小寫字母名稱來訪問你的類:
~~~
$this->someclass->some_method();? // Object instances will always be lower case
~~~
## 初始化類時傳入參數
在加載類庫的時候,你可以通過第二個參數動態的傳遞一個數組數據,該數組將被傳到 你的類的構造函數中:
~~~
$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');
// 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()?函數通過引用來傳遞:
~~~
$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_**?開頭,所以請不要使用這個 作為你的自定義前綴。
- 歡迎使用 CodeIgniter
- 安裝說明
- 下載 CodeIgniter
- 安裝說明
- 從老版本升級
- 疑難解答
- CodeIgniter 概覽
- CodeIgniter 將從這里開始
- CodeIgniter 是什么?
- 支持特性
- 應用程序流程圖
- 模型-視圖-控制器
- 設計與架構目標
- 教程 - 內容提要
- 加載靜態內容
- 讀取新聞條目
- 創建新聞條目
- 結束語
- 常規主題
- CodeIgniter URL
- 控制器
- 保留名稱
- 視圖
- 模型
- 輔助函數
- 使用 CodeIgniter 類庫
- 創建類庫
- 使用 CodeIgniter 驅動器
- 創建驅動器
- 創建核心系統類
- 創建附屬類
- 鉤子 - 擴展框架核心
- 自動加載資源
- 公共函數
- 兼容性函數
- URI 路由
- 錯誤處理
- 網頁緩存
- 程序分析
- 以 CLI 方式運行
- 管理你的應用程序
- 處理多環境
- 在視圖文件中使用 PHP 替代語法
- 安全
- PHP 開發規范
- 類庫參考
- 基準測試類
- 緩存驅動器
- 日歷類
- 購物車類
- 配置類
- Email 類
- 加密類
- 加密類(新版)
- 文件上傳類
- 表單驗證類
- FTP 類
- 圖像處理類
- 輸入類
- Javascript 類
- 語言類
- 加載器類
- 遷移類
- 輸出類
- 分頁類
- 模板解析類
- 安全類
- Session 類
- HTML 表格類
- 引用通告類
- 排版類
- 單元測試類
- URI 類
- 用戶代理類
- XML-RPC 與 XML-RPC 服務器類
- Zip 編碼類
- 數據庫參考
- 數據庫快速入門: 示例代碼
- 數據庫配置
- 連接你的數據庫
- 查詢
- 生成查詢結果
- 查詢輔助函數
- 查詢構造器類
- 事務
- 數據庫元數據
- 自定義函數調用
- 數據庫緩存類
- 數據庫工廠類
- 數據庫工具類
- 數據庫驅動器參考
- 輔助函數參考
- 數組輔助函數
- 驗證碼輔助函數
- Cookie 輔助函數
- 日期輔助函數
- 目錄輔助函數
- 下載輔助函數
- 郵件輔助函數
- 文件輔助函數
- 表單輔助函數
- HTML 輔助函數
- 語言輔助函數
- Inflector 輔助函數
- 數字輔助函數
- 路徑輔助函數
- 安全輔助函數
- 表情輔助函數
- 字符串輔助函數
- 文本輔助函數
- 排版輔助函數
- URL 輔助函數
- XML 輔助函數
- 向 CodeIgniter 貢獻你的力量