Codeigniter Tutorials

Home » Codeigniter »

How to Create custom library in codeigniter ?

Codeigniter libraries means classes which located in libraries directory. so for create our own custom library in codeigniter we need to build classes and store class file in libraries directory full path of libraries directory will be “application/libraries”. It’s easy to create new/ custom library , replace native or extend native library in codeigniter. Below in this tutorial we will discuss :-

Create new/custom libraries

Using new/custom libraries

Extend native libraries

Create new/custom libraries :- We need to create our own or custom library to add some new functionality.
Library rules / naming :-

New library file must be stored in "application/libraries" directory.

Library file names must be capitalized. like: Example.php

Class declarations in library must be capitalized. like: class Example

Library class name and library file name must match.

Class Example :- creating a "Example.php" file under "application/libraries/Example.php" and add below code.

File name : Example.php

<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
class Example {
public function my_function() {
// do your stuff
}
}

Using new/custom libraries :- After create custom library let’s see how to use this library in controller/model/view.

Include or initialize library :- first you need to include library to use functionality to include call below function where you need. Need to pass filename(case insensitive) “example” without “.php” extension.

$this->load->library('example');
// or $this->load->library('Example');

or autoloading library by "applications/config/autoload.php" (will include for all pages)

$autoload['helper'] = array('example');

Passing parameters on class Initialization :- for this your class must have a constructor

File name : index.php

$arr = array('name'=>'mahtab');
$this->load->library('example', $arr);

//class

class Example {
public function __construct($arr) {
// Do your stuff with $arr
}
}

Calling library function :- after load you can access class function with Object instances will be lower case.

$this->example->my_function();

Passing parameter to function:-

<p>$arr = array('name'=>'mahtab');<br />
$this->example->my_function($arr);<br />
// class function :- public function my_function($arr){}</p>

Use codeigniter resources in Library :- you can also use another library, config, helper etc. in your custom library with CI instance like

$CI =& get_instance();
$CI->load->helper('myhelper');
$CI->load->library('email');
$CI->config->item('myitem');

Extend native libraries :- extend means you are adding some more functionality to existing library. for extend native library your

library name must be start with MY_

Class must extend parent class.

First Add class prefix to config :- go to applications/config/config.php and add subclass_prefix
$config['subclass_prefix'] = 'MY_';

We are going to extend CI_Form_validation :- create a file MY_Form_validation.php under “application/libraries/MY_Form_validation.php” and adding new form validation

Now need to include this library :-

$this->load->library('form_validation');

and call this validation rule like:-
$this->form_validation->set_rules('name',Name', 'trim|required|xss_clean|alpha_space');

<?php if (!defined('BASEPATH')) exit('No direct script access allowed');
class MY_Form_validation extends CI_Form_validation {
// check for alpha and space
function alpha_space($str) {
return ( ! preg_match("/^([a-z ])+$/i", $str)) ? FALSE : TRUE;
}
}

http://www.anil2u.info/2015/03/how-to-create-custom-library-file-in-codeigniter/

How to create custom library file in CodeIgniter

Step 1 :
Go to folder application -> libraries

Step 2 :
Create a PHP file with YourLibraryName_lib.php

Step 3 :
Starting of library file write below code

Note: We can change description according to your requirement.

Step 4 :

Create library class with database connection and load the pre-defined libraries

class Anillabs_lib {
var $CI;
public function __construct($params = array())
{
$this->CI =& get_instance();

$this->CI->load->helper('url');
$this->CI->config->item('base_url');
$this->CI->load->database();

}

Step 5

We can write your function to manipulate

public function getMetadata($pageid){
$sql = "SELECT * FROM pages WHERE pageid = ?";
$results = $this->CI->db->query($sql, array($pageid));
$pageMetadata = $results->row();
$data['keywords'] = $pageMetadata->keywords;
$data['description'] = $pageMetadata->description;
$this->CI->load->view('templates/header',$data);
}

Step 6 :

Go to /application/config/autoload.php

Search for

$autoload['libraries']
and add your library file which you need to allow in complete application. If you don’t want to allow in complete application then we can write below code in single controller

$this->load->library('anillabs_lib');

Step 7 :

Once you load library file in above step, next calling library file in your controller method like below
$this->anillabs_lib->getMetadata(5);

Complete library file code :-

<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* CodeIgniter
*
* An open source application development framework for PHP 5.1.6 or newer
*
* @package CodeIgniter
* @author Anil Kumar Panigrahi
* @copyright Copyright (c) 2015, Anil Labs.
* @license
* @link http://www.anil2u.info
* @since Version 1.0
* @filesource
*/

// ------------------------------------------------------------------------

/**
* Anil Labs core CodeIgniter class
*
* @package CodeIgniter
* @subpackage Libraries
* @category Anil Labs
* @author Anil Kumar Panigrahi
* @link http://www.anil2u.info
*/

class Anillabs_lib {
var $CI;
public function __construct($params = array())
{
$this->CI =& get_instance();

$this->CI->load->helper('url');
$this->CI->config->item('base_url');
$this->CI->load->database();

}

public function getMetadata($pageid){
$sql = "SELECT * FROM pages WHERE pageid = ?";
$results = $this->CI->db->query($sql, array($pageid));
$pageMetadata = $results->row();
$data['keywords'] = $pageMetadata->keywords;
$data['description'] = $pageMetadata->description;
$this->CI->load->view('templates/header',$data);
}
}