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实现MVC开发得最简单的方法――模型
Apr 10 PHP
php pcntl_fork和pcntl_fork 的用法
Apr 13 PHP
对squid中refresh_pattern的一些理解和建议
Apr 17 PHP
php学习笔记 php中面向对象三大特性之一[封装性]的应用
Jun 13 PHP
PHP将XML转数组过程详解
Nov 13 PHP
PHP设计模式之观察者模式(Observer)详细介绍和代码实例
Apr 08 PHP
探寻PHP脚本不报错的原因
Jun 12 PHP
php foreach正序倒序输出示例代码
Jul 01 PHP
PHP定时任务延缓执行的实现
Oct 08 PHP
PHP实现HTML生成PDF文件的方法
Nov 07 PHP
php扩展开发入门demo示例
Sep 23 PHP
Thinkphp5.0框架的Db操作实例分析【连接、增删改查、链式操作等】
Oct 11 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 文件上传模型,支持多文件上传
2009/08/13 PHP
支持数组的ADDSLASHES的php函数
2010/02/16 PHP
PHP设计模式(八)装饰器模式Decorator实例详解【结构型】
2020/05/02 PHP
国外大牛IE版本检测!现在IE都到9了,IE检测代码
2012/01/04 Javascript
JS中的substring和substr函数的区别说明
2013/05/07 Javascript
js使用onmousemove和onmouseout获取鼠标坐标的方法
2015/03/31 Javascript
JavaScript 浏览器对象模型BOM使用介绍
2015/04/13 Javascript
window.onload与$(document).ready()的区别分析
2015/05/30 Javascript
关于cookie的初识和运用(js和jq)
2016/04/07 Javascript
webpack中CommonsChunkPlugin详细教程(小结)
2017/11/09 Javascript
微信小程序公用参数与公用方法用法示例
2019/01/09 Javascript
JavaScript实现栈结构Stack过程详解
2020/03/07 Javascript
Nuxt默认模板、默认布局和自定义错误页面的实现
2020/05/11 Javascript
javascript自定义加载loading效果
2020/09/15 Javascript
vue 数据操作相关总结
2020/12/17 Vue.js
[02:08:58]2014 DOTA2国际邀请赛中国区预选赛 Ne VS CIS
2014/05/22 DOTA
python计算最大优先级队列实例
2013/12/18 Python
Python学习笔记_数据排序方法
2014/05/22 Python
python通过pil模块将raw图片转换成png图片的方法
2015/03/16 Python
Python编程给numpy矩阵添加一列方法示例
2017/12/04 Python
Python使用爬虫爬取静态网页图片的方法详解
2018/06/05 Python
python numpy 部分排序 寻找最大的前几个数的方法
2018/06/27 Python
Python将字符串常量转化为变量方法总结
2019/03/17 Python
python实现手机销售管理系统
2019/03/19 Python
tensorflow之获取tensor的shape作为max_pool的ksize实例
2020/01/04 Python
vscode+PyQt5安装详解步骤
2020/08/12 Python
Python 生成短8位唯一id实战教程
2021/01/13 Python
全球最大最受欢迎的旅游社区:Tripadvisor
2017/11/03 全球购物
CNC数控操作工岗位职责
2013/11/19 职场文书
实习生个人的自我评价
2013/12/08 职场文书
室内拓展活动方案
2014/02/13 职场文书
党的群众路线教育实践活动党员个人整改措施
2014/10/27 职场文书
个人求职自荐信范文
2015/03/06 职场文书
同事去世追悼词
2015/06/23 职场文书
详解Redis集群搭建的三种方式
2021/05/31 Redis
python通过新建环境安装tfx的问题
2022/05/20 Python