脢廬脪祿隆壟脌漏脮鹿 · tp5文檔

# 快速入門（十一）：擴展 `ThinkPHP5`對擴展的支持更加方便和靈活，`5.0`版本的擴展原則是不在核心目錄添加任何擴展和文件，以確保核心框架的更新。 - - [函數擴展](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/197464#u51FDu6570u6269u5C55) - [類庫擴展](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/197464#u7C7Bu5E93u6269u5C55) - [驅動擴展](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/197464#u9A71u52A8u6269u5C55) - [Composer擴展](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/197464#composer-) ## 函數擴展如果要擴展自己的全局自定義函數，或者重寫系統的助手函數，可以直接在應用目錄下面的`common.php`文件（`application/common.php`）中定義，例如： ``` <pre class="calibre18"> ``` // 增加一個新的table助手函數function table($table, $config = []){ return \think\Db::connect($config)->setTable($table); } // 替換框架內置的db助手函數function db($name, $config = []){ return \think\Db::connect($config)->name($name); } ``` ``` 如果只是定義某個模塊需要使用的函數，則可以放到模塊的公共文件中，例如定義`index`模塊使用的函數可以在`application/index/common.php`中。 ## 類庫擴展如果你需要在核心之外擴展和使用第三方類庫，并且該類庫不是通過`Composer`安裝使用，那么可以直接放入應用根目錄下面的`extend`目錄下面，該目錄是官方建議的第三方擴展類庫目錄。 `extend`目錄下面的類庫必須遵循`PSR-4`自動加載規范，系統會按照目錄自動注冊命名空間，下面是一個`org\util\ArrayList`類： ``` <pre class="calibre18"> ``` <?phpnamespace org\util; /** * ArrayList實現類 * @author liu21st <liu21st@gmail.com> */class ArrayList implements \IteratorAggregate{ /** * 集合元素 * @var array * @access protected */protected $elements = []; /** * 架構函數 * @access public * @param string $elements 初始化數組元素 */public function __construct($elements = []){ if (!empty($elements)) { $this->elements = $elements; } } /** * 若要獲得迭代因子，通過getIterator方法實現 * @access public * @return ArrayObject */public function getIterator(){ return new \ArrayObject($this->elements); } /** * 增加元素 * @access public * @param mixed $element 要添加的元素 * @return boolean */public function add($element){ return (array_push($this->elements, $element)) ? true : false; } // 在數組開頭插入一個單元public function unshift($element){ return (array_unshift($this->elements, $element)) ? true : false; } // 將數組最后一個單元彈出（出棧）public function pop(){ return array_pop($this->elements); } /** * 增加元素列表 * @access public * @param ArrayList $list 元素列表 * @return boolean */public function addAll($list){ $before = $this->size(); foreach ($list as $element) { $this->add($element); } $after = $this->size(); return ($before < $after); } /** * 清除所有元素 * @access public */public function clear(){ $this->elements = []; } /** * 是否包含某個元素 * @access public * @param mixed $element 查找元素 * @return string */public function contains($element){ return (array_search($element, $this->elements) !== false); } /** * 根據索引取得元素 * @access public * @param integer $index 索引 * @return mixed */public function get($index){ return $this->elements[$index]; } /** * 查找匹配元素，并返回第一個元素所在位置 * 注意可能存在0的索引位置因此要用===False來判斷查找失敗 * @access public * @param mixed $element 查找元素 * @return integer */public function indexOf($element){ return array_search($element, $this->elements); } /** * 判斷元素是否為空 * @access public * @return boolean */public function isEmpty(){ return empty($this->elements); } /** * 最后一個匹配的元素位置 * @access public * @param mixed $element 查找元素 * @return integer */public function lastIndexOf($element){ for ($i = (count($this->elements) - 1); $i > 0; $i--) { if ($this->get($i) == $element) { return $i; } } } public function toJson(){ return json_encode($this->elements); } /** * 根據索引移除元素 * 返回被移除的元素 * @access public * @param integer $index 索引 * @return mixed */public function remove($index){ $element = $this->get($index); if (!is_null($element)) { array_splice($this->elements, $index, 1); } return $element; } /** * 移出一定范圍的數組列表 * @access public * @param integer $offset 開始移除位置 * @param integer $length 移除長度 */public function removeRange($offset, $length){ array_splice($this->elements, $offset, $length); } /** * 移出重復的值 * @access public */public function unique(){ $this->elements = array_unique($this->elements); } /** * 取出一定范圍的數組列表 * @access public * @param integer $offset 開始位置 * @param integer $length 長度 */public function range($offset, $length = null){ return array_slice($this->elements, $offset, $length); } /** * 設置列表元素 * 返回修改之前的值 * @access public * @param integer $index 索引 * @param mixed $element 元素 * @return mixed */public function set($index, $element){ $previous = $this->get($index); $this->elements[$index] = $element; return $previous; } /** * 獲取列表長度 * @access public * @return integer */public function size(){ return count($this->elements); } /** * 轉換成數組 * @access public * @return array */public function toArray(){ return $this->elements; } // 列表排序public function ksort(){ ksort($this->elements); } // 列表排序public function asort(){ asort($this->elements); } // 逆向排序public function rsort(){ rsort($this->elements); } // 自然排序public function natsort(){ natsort($this->elements); } } ``` ``` 我們把類文件放到`extend/org/util/ArrayList.php`，就可以直接使用該類了，注意`ArrayList`類的完整命名空間應該是`org\util\ArrayList`，而不是`extend\org\util\ArrayList`，下面我們來寫個例子測試下是否可以正常使用該擴展類庫，控制器代碼如下： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; use org\uitl\ArrayList; class Index{ public funtion index() { $list = ['thinkphp', 'thinkphp', 'onethink', 'topthink']; $arrayList = new ArrayList($list); $arrayList->add('kancloud'); $arrayList->unique(); dump($arrayList->toArray()); echo $arrayList->toJson(); } } ``` ``` 訪問輸出的結果為： ``` <pre class="calibre18"> ``` array (size=4) 0 => string 'thinkphp' (length=8) 2 => string 'onethink' (length=8) 3 => string 'topthink' (length=8) 4 => string 'kancloud' (length=8) {"0":"thinkphp","2":"onethink","3":"topthink","4":"kancloud"} ``` ``` `extend`擴展目錄通常是放一些全局并且和應用無關的公共類庫，如果是應用相關的類庫則可以納入應用目錄，例如： ``` <pre class="calibre18"> ``` <?phpnamespace app\common\util; class Auth{ public static funtion check($uid) { return true; } } ``` ``` 類庫文件位于`application/common/util/Auth.php`。 ## 驅動擴展驅動擴展其實是一種比較特別的類庫擴展而已，因為針對不同的驅動有不同的方法規范，驅動擴展不需要放入核心目錄，你可以在任何位置擴展相關驅動，官方推薦的方式是在`extend`目錄下面的`driver`子目錄放置所有的驅動擴展。 ``` <pre class="calibre18"> ``` extend/driver ├─cache // 緩存擴展驅動目錄 ├─db // 數據庫擴展驅動目錄 ├─debug // 調試擴展驅動目錄 ├─log // 日志擴展驅動目錄 ├─session // SESSION擴展驅動目錄 ├─template // 模板標簽擴展驅動目錄 ├─... ``` ``` 以日志擴展為例，我們來擴展一個日志驅動滿足項目的實際需求，該日志驅動會把指定的日志信息發送到指定郵箱，驅動類實現如下： ``` <pre class="calibre18"> ``` <?phpnamespace driver\log; /** * 本地化調試輸出到文件 */class Email{ protected $config = [ 'time_format' => ' c ', 'email_addr' => '', 'send_level' => ['error'], ]; // 實例化并傳入參數public function __construct($config = []){ if (is_array($config)) { $this->config = array_merge($this->config, $config); } } /** * 日志寫入接口 * @access public * @param array $log 日志信息 * @return bool */public function save(array $log = []){ $now = date($this->config['time_format']); $info = ''; $server = isset($_SERVER['SERVER_ADDR']) ? $_SERVER['SERVER_ADDR'] : '0.0.0.0'; $remote = isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : '0.0.0.0'; $method = isset($_SERVER['REQUEST_METHOD']) ? $_SERVER['REQUEST_METHOD'] : 'CLI'; $uri = isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : ''; foreach ($log as $type => $val) { if (in_array($type, $this->config['send_level'])) { foreach ($val as $msg) { if (!is_string($msg)) { $msg = var_export($msg, true); } $info .= '[ ' . $type . ' ] ' . $msg . " "; } } } return error_log("[{$now}] {$server} {$remote} {$method} {$uri}<div>{$info}</div>", 1, $this->config['email_addr'],"Subject: Log-{$now}"); } } ``` ``` 然后，修改應用配置文件中的`log`參數為： ``` <pre class="calibre18"> ``` 'log' => [ 'type' => 'driver\log\Email', 'email_addr' => 'thinkphp@qq.com', 'send_level' => ['error', 'info'], ], ``` ``` 為了確保郵件發送正常，你可能還需要配置郵件服務參數，如果是`windows`服務器，配置`php.ini`文件中的相關參數 ``` <pre class="calibre18"> ``` SMTP = 你的smtp服務器host（域名或者IP） smtp_port = 端口號（默認25） sendmail_from = "發送郵件的來源信息" ``` ``` 如果是`Linux`系統，一般無需配置或者在`php.ini`設置`sendmail_path`參數： ``` <pre class="calibre18"> ``` sendmail_path = sendmail 程序的路徑（通常是 /usr/sbin/sendmail 或 /usr/lib/sendmail） ``` ``` 下面是一個測試例子： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; use think\Log; class Index{ public function index(){ Log::error('測試錯誤'); } } ``` ``` 當運行后，如果你的郵件服務配置正確，會收到一份郵件通知，否則可能會拋出異常頁面。 ## Composer擴展很多情況下，我們的擴展需要依賴其它的第三方擴展，那么為了有效解決依賴問題，使用Composer擴展包是最方便的開發模式。關于如何使用`composer`擴展我們會在后面介紹官方擴展的時候給你詳細描述。