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

本文实例讲述了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相关内容感兴趣的读者可查看本站专题:《codeigniter入门教程》、《CI(CodeIgniter)框架进阶教程》、《php优秀开发框架总结》、《ThinkPHP入门教程》、《ThinkPHP常用方法总结》、《Zend FrameWork框架入门教程》、《php面向对象程序设计入门教程》、《php+mysql数据库操作入门教程》及《php常见数据库操作技巧汇总》

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

(0)

相关推荐

  • CI框架(CodeIgniter)公共模型类定义与用法示例

    本文实例讲述了CI框架(CodeIgniter)公共模型类定义与用法.分享给大家供大家参考,具体如下: 我们都知道,操作数据库的方法都写在模型中.但是一般情况下,一张表往往至少对应4个操作,也就是所谓crud.那么如果20张表,所对应的模型方法,就达到了80个,重复的操作显然这已经是一个体力活儿. 那么就对单表操作时,我们进行一下简单的封装.如下是ci框架的示例: <?php /** * Created by PhpStorm. * User: kangjianrong * Date: 16-8

  • CI框架附属类用法分析

    本文实例讲述了CI框架附属类用法.分享给大家供大家参考,具体如下: 有些时候,你可能想在你的控制器之外新建一些类,但同时又希望 这些类还能访问 CodeIgniter 的资源 任何在你的控制器方法中初始化的类都可以简单的通过 get_instance() 函数来访问 CodeIgniter 资源.这个函数返回一个 CodeIgniter 对象. 通常来说,调用 CodeIgniter 的方法需要使用 $this $this->load->helper('url'); $this->loa

  • CI框架简单邮件发送类实例

    本文实例讲述了CI框架简单邮件发送类.分享给大家供大家参考,具体如下: ci框架绝对是php初学中想要的东西,它能极大的缩短你的代码量! 下面看看我的发送邮件的简单演示: function email() { $this->load->library('email'); $config['protocol'] = 'smtp'; $config['smtp_host'] = 'smtp.163.com'; $config['smtp_user'] = 'jb51@163.com';//这里写上

  • CI框架中类的自动加载问题分析

    本文实例讲述了CI框架中类的自动加载问题.分享给大家供大家参考,具体如下: application/config 配置文件中添加: | 1. Packages | 2. Libraries | 3. Helper files | 4. Custom config files | 5. Language files | 6. Models 1. 第三方库文件加载 // $autoload['packages'] = array(APPPATH.'third_party', '/usr/local/

  • CI框架常用经典操作类总结(路由,伪静态,分页,session,验证码等)

    本文实例总结了CI框架常用经典操作类.分享给大家供大家参考,具体如下: 1. 超级对象中的URI CI_URI类的解析url的相关信息 直接使用$this->uri可以使用它的相关属性 system/core/URI.php文件中 部分常用属性: (1) 分段获取url相关信息 $this->uri->segment(4); //获取url中pathinfo //的第四段的值 入口文件.php/控制器/动作/参数1/参数2/... (2) 通过方法中的形参传参 需要设默认值和顺序要注意

  • CI框架安全类Security.php源码分析

    CI安全类提供了全局防御CSRF攻击和XSS攻击策略,只需要在配置文件开启即可: 复制代码 代码如下: $config['csrf_protection'] = TRUE; $config['global_xss_filtering'] = TRUE; 并提供了实用方法: 复制代码 代码如下: $this->security->xss_clean($data);//第二个参数为TRUE,验证图片安全 $this->security->sanitize_filename()//过滤文

  • CI框架扩展系统核心类的方法分析

    本文实例讲述了CI框架扩展系统核心类的方法.分享给大家供大家参考,具体如下: 首先你系统扩展类是放在application/core下面的,本来系统核心类是CI_Controller,所以你不能以CI_开头了,你需要打开 application/config/config.php 修改: $config['subclass_prefix'] = 'MY_'; 为你的前缀! 一些公共的模块就可以卸载自己的核心类里面了! 这几天读了Dilicms(轻量级的后台架构),比如说他的后台扩展类是这样的:

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

    本文实例讲述了CI框架实现创建自定义类库的方法.分享给大家供大家参考,具体如下: 当我们使用 "类库" 这个词的时候,通常我们指的是位于 libraries 这个目录下的那些类. 接下来我们将介绍 如何在 application/libraries 目录下创建你自己的类库,和全局的框架类库独立开来. 另外,如果你希望在现有的类库中添加某些额外功能,CodeIgniter 允许你扩展原生的类, 或者你甚至可以在你的 application/libraries 目录下放置一个和原生的类库同

  • AngularJS基于factory创建自定义服务的方法详解

    本文实例讲述了AngularJS基于factory创建自定义服务的方法.分享给大家供大家参考,具体如下: 为什么要创建自定义服务? 很简单,不想让控制器显得过于"臃肿",而且服务可复用.针对性强,每个服务对应不同的功能. 这里介绍如何使用factory创建自定义服务,并且使用他. 例子1: <!--HTML--> <div ng-controller="showTheName"> <h1 ng-bind="name"

  • AngularJS创建自定义指令的方法详解

    本文实例讲述了AngularJS创建自定义指令的方法.分享给大家供大家参考,具体如下: 这是一篇译文,来自angular开发者说明的指令.主要面向已经熟悉angular开发基础的开发者.这篇文档解释了什么情况下需要创建自己的指令,和如何去创建指令. 什么是指令 从一个高的层面来讲,指令是angular $compile服务的说明,当特定的标签(属性,元素名,或者注释) 出现在DOM中的时候,它让编译器附加指定的行为到DOM上. 这个过程是很简单的.angular内部有很用这样自带的指令,比如说n

  • CI框架数据库查询缓存优化的方法

    本文实例讲述了CI框架数据库查询缓存优化的方法.分享给大家供大家参考,具体如下: CI框架中有个比较好的查询优化,就是数据库缓存优化 1.开启缓存 //在application/config.php中开启 $db['default']['cache_on'] = TRUE; //在application/config.php中开启 $db['default']['cachedir'] = './cache'; //并在对应的目录中加一个可写缓存目录cache 2. 在对应的查询中开启缓存语句 /

  • Javascript 中创建自定义对象的方法汇总

    Javascript 中创建对象,可以有很多种方法. Object构造函数/对象字面量: 抛开设计模式不谈,使用最基本的方法,就是先调用Object构造函数创建一个对象,然后给对象添加属性. 复制代码 代码如下: var student = new Object();      student.name = "xiao ming";      student.age = 20;      student.getName = function () {          alert(th

  • CI框架整合widget(页面格局)的方法

    本文实例讲述了CI框架整合widget(页面格局)的方法.分享给大家供大家参考,具体如下: 在WEB开发过程中,我们免不了要输出视图文件,而通常视图文件又一般都少不了头部.左侧栏以及底部这些公共元素. 如何让整个项目开发在涉及视图套用时引入敏捷的思维,提高效率呢?就不得不提一下widget.承然你也大可以使用HMVC模型. 这里仅介绍下widget如何结合入CI框架中: 1.在类文件MY_Controller.php中添加调用方法: /* * 如果$name存在则调用widget类及widget

  • Vscode中快速创建自定义代码模板的方法

    Vscode中快速创建自定义代码模板 一招鲜,吃遍天,学会了这个在Vscode中快速创建自定义代码模板的教程,我相信创建其它代码模板的方法你也就通个七七八八了. 我就以Vue的创建为例,不过我这个Vue是在HTML中创建的. 初学Vue,我们一般都是在.html文件中引入vue包,然后编写自己的vue代码. 盲目的跟着网上那些教程创建Vue模板是行不通的. 因为我们创建的模板是在.html文件下,所以我们的模板也得是在html.json中来进行编写. 教程如下: 图文并用,理解更清晰到位! 在V

  • 微信利用PHP创建自定义菜单的方法

    在使用通用接口前,你需要做以下两步工作: 1.拥有一个微信公众账号,并获取到appid和appsecret(在公众平台申请内测资格,审核通过后可获得) 2.通过获取凭证接口获取到access_token 注意: access_token是第三方访问api资源的票据: access_token对应于公众号是全局唯一的票据,重复获取将导致上次获取的access_token失效. 访问下面这个地址(注意替换你的appid和secret): https://api.weixin.qq.com/cgi-b

  • 详解在Python的Django框架中创建模板库的方法

    不管是写自定义标签还是过滤器,第一件要做的事是创建模板库(Django能够导入的基本结构). 创建一个模板库分两步走: 第一,决定模板库应该放在哪个Django应用下. 如果你通过 manage.py startapp 创建了一个应用,你可以把它放在那里,或者你可以为模板库单独创建一个应用. 我们更推荐使用后者,因为你的filter可能在后来的工程中有用. 无论你采用何种方式,请确保把你的应用添加到 INSTALLED_APPS 中. 我们稍后会解释这一点. 第二,在适当的Django应用包里创

  • JAVA集合框架工具类自定义Collections集合方法

    项目中有需要多次统计 某些集合中 的某个属性值,所以考虑封装一个方法,让其其定义实现计算方式. 话不多说,看代码: 1.封装的自定义集合工具类:CollectionsCustom package com.test.util; import java.util.Collection; import org.apache.commons.collections.CollectionUtils; /** * 自定义集合处理类 */ public class CollectionsCustom { /*

随机推荐