CI框架实现创建自定义类库的方法


Posted in PHP onDecember 25, 2018

本文实例讲述了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_ 开头,所以请不要使用这个 作为你的自定义前缀。

希望本文所述对大家基于CodeIgniter框架的PHP程序设计有所帮助。

PHP 相关文章推荐
php fckeditor 调用的函数
Jun 21 PHP
PHP访问MYSQL数据库封装类(附函数说明)
Dec 04 PHP
php去除重复字的实现代码
Sep 16 PHP
单一index.php实现PHP任意层级文件夹遍历(Zjmainstay原创)
Jul 31 PHP
PHP图像处理之imagecreate、imagedestroy函数介绍
Nov 19 PHP
Java和PHP在Web开发方面对比分析
Mar 01 PHP
深入分析PHP优化及注意事项
Jul 04 PHP
PHP实现添加购物车功能
Mar 06 PHP
ThinkPHP3.2框架使用addAll()批量插入数据的方法
Mar 16 PHP
PHP错误处理函数register_shutdown_function使用示例
Jul 03 PHP
PHP模版引擎原理、定义与用法实例
Mar 29 PHP
thinkphp5 模型实例化获得数据对象的教程
Oct 18 PHP
PHP中soap用法示例【SoapServer服务端与SoapClient客户端编写】
Dec 25 #PHP
PHP使用SOAP调用API操作示例
Dec 25 #PHP
详解PHP实现支付宝小程序用户授权的工具类
Dec 25 #PHP
PHP正则匹配到2个字符串之间的内容方法
Dec 24 #PHP
PHP基于PDO扩展操作mysql数据库示例
Dec 24 #PHP
PHP封装的page分页类定义与用法完整示例
Dec 24 #PHP
tp5(thinkPHP5)框架连接数据库的方法示例
Dec 24 #PHP
You might like
生成静态页面的php函数,php爱好者站推荐
2007/03/19 PHP
PHP中动态显示签名和ip原理
2007/03/28 PHP
php制作unicode解码工具(unicode编码转换器)代码分享
2013/12/24 PHP
php生成唯一的订单函数分享
2015/02/02 PHP
PHP基于GD库的图像处理方法小结
2016/09/27 PHP
PHP+Mysql无刷新问答评论系统(源码)
2016/12/20 PHP
写出更好的JavaScript程序之undefined篇(中)
2009/11/23 Javascript
有趣的javascript数组定义方法
2010/09/10 Javascript
使用javascript实现ListBox左右全选,单选,多选,全请
2013/11/07 Javascript
只需一行代码,轻松实现一个在线编辑器
2013/11/12 Javascript
使用jquery.validate自定义方法实现&quot;手机号码或者固话至少填写一个&quot;的逻辑验证
2014/09/01 Javascript
javascript多行字符串的简单实现方式
2015/05/04 Javascript
浅析angularJS中的ui-router和ng-grid模块
2016/05/20 Javascript
使用jQuery加载html页面到指定的div实现方法
2016/07/13 Javascript
JS中静态页面实现微信分享功能
2017/02/06 Javascript
Vue input控件通过value绑定动态属性及修饰符的方法
2017/05/03 Javascript
vue.js 获取select中的value实例
2018/03/01 Javascript
vue左右侧联动滚动的实现代码
2018/06/06 Javascript
微信小程序 JS动态修改样式的实现方法
2018/12/16 Javascript
Node.js Event Loop各阶段讲解
2019/03/08 Javascript
Egg Vue SSR 服务端渲染数据请求与asyncData
2019/11/24 Javascript
如何配置vue.config.js 处理static文件夹下的静态文件
2020/06/19 Javascript
Python中实现参数类型检查的简单方法
2015/04/21 Python
使用python实现对元素的长截图功能
2019/11/14 Python
Python如何使用argparse模块处理命令行参数
2019/12/11 Python
Dr. Martens马汀博士澳大利亚官网:马丁靴鼻祖
2019/07/02 全球购物
医科大学生的自我评价
2013/12/04 职场文书
保险公司晨会主持词
2014/03/22 职场文书
大队干部竞选演讲稿
2014/04/28 职场文书
森马旗舰店双十一营销方案
2014/09/29 职场文书
毕业实习指导教师评语
2014/12/31 职场文书
无罪辩护词范文
2015/05/21 职场文书
法人代表证明书范本
2015/06/18 职场文书
Python关于OS文件目录处理的实例分享
2021/05/23 Python
关于ObjectUtils.isEmpty() 和 null 的区别
2022/02/28 Java/Android
以MySQL5.7为例了解一下执行计划
2022/04/13 MySQL