脢庐脪禄隆垄脌漏脮鹿 · tp5文档

# 快速入门（十一）：扩展 `ThinkPHP5`对扩展的支持更加方便和灵活，`5.0`版本的扩展原则是不在核心目录添加任何扩展和文件，以确保核心框架的更新。 - - [函数扩展](http://ihavenolimitations.xyz/thinkphp/thinkphp5_quickstart/197464#u51FDu6570u6269u5C55) - [类库扩展](http://ihavenolimitations.xyz/thinkphp/thinkphp5_quickstart/197464#u7C7Bu5E93u6269u5C55) - [驱动扩展](http://ihavenolimitations.xyz/thinkphp/thinkphp5_quickstart/197464#u9A71u52A8u6269u5C55) - [Composer扩展](http://ihavenolimitations.xyz/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`扩展我们会在后面介绍官方扩展的时候给你详细描述。