How to integrate custom template in codeigniter?

Today I will explain about template functionality of codeigniter and how to integrate custom template in codeigniter.

Now let’s start with folder structure of codeigniter framework.
Codeigniter folder structure
Here in the above folders just move to applications -> libraries folder, under libraries create Template.php library file and add code as below.

<?php  if (!defined('BASEPATH')) exit('No direct script access allowed');
/**
* CodeIgniter
*
* An open source application development framework for PHP 4.3.2 or newer
*
* @package CodeIgniter
* @author  ExpressionEngine Dev Team
* @copyright  Copyright (c) 2006, EllisLab, Inc.
* @license http://codeigniter.com/user_guide/license.html
* @link http://codeigniter.com
* @since   Version 1.0
* @filesource
*/
// --------------------------------------------------------------------
/**
* CodeIgniter Template Class
*
* This class is and interface to CI's View class. It aims to improve the
* interaction between controllers and views. Follow @link for more info
*
* @package		CodeIgniter
* @author		Colin Williams
* @subpackage	Libraries
* @category	Libraries
* @link		http://www.williamsconcepts.com/ci/libraries/template/index.html
* @copyright  Copyright (c) 2008, Colin Williams.
* @version 1.4.1
* 
*/
class CI_Template {
var $CI;
var $config;
var $template;
var $master;
var $regions=array(
'_scripts'=> array(),
'_styles'=> array(),
);
var $output;
var $js=array();
var $css=array();
var $parser='parser';
var $parser_method='parse';
var $parse_template=FALSE;
/**
* Constructor
*
* Loads template configuration, template regions, and validates existence of 
* default template
*
* @access	public
*/
function CI_Template()
{
// Copy an instance of CI so we can use the entire framework.
$this->CI=& get_instance();
// Load the template config file and setup our master template and regions
include(APPPATH.'config/template'.EXT);
if (isset($template))
{
$this->config=$template;
$this->set_template($template['active_template']);
}
}
// --------------------------------------------------------------------
/**
* Use given template settings
*
* @access  public
* @param   string   array key to access template settings
* @return  void
*/
function set_template($group)
{
if (isset($this->config[$group]))
{
$this->template=$this->config[$group];
}
else
{
show_error('The "'. $group .'" template group does not exist. Provide a valid group name or add the group first.');
}
$this->initialize($this->template);
}
// --------------------------------------------------------------------
/**
* Set master template
*
* @access  public
* @param   string   filename of new master template file
* @return  void
*/
function set_master_template($filename)
{
if (file_exists(APPPATH .'views/templates/'. $filename) or file_exists(APPPATH .'views/templates/'. $filename . EXT))
{
$this->master=$filename;
}
else
{
show_error('The filename provided does not exist in <strong>'. APPPATH .'views</strong>. Remember to include the extension if other than ".php"');
}
}
// --------------------------------------------------------------------
/**
* Dynamically add a template and optionally switch to it
*
* @access  public
* @param   string   array key to access template settings
* @param   array properly formed
* @return  void
*/
function add_template($group, $template, $activate=FALSE)
{
if ( ! isset($this->config[$group]))
{
$this->config[$group]=$template;
if ($activate===TRUE)
{
$this->initialize($template);
}
}
else
{
show_error('The "'. $group .'" template group already exists. Use a different group name.');
}
}
// --------------------------------------------------------------------
/**
* Initialize class settings using config settings
*
* @access  public
* @param   array   configuration array
* @return  void
*/
function initialize($props)
{
// Set master template
if (isset($props['template']) 
&& (file_exists(APPPATH .'views/templates/'. $props['template']) or file_exists(APPPATH .'views/templates/'. $props['template'] . EXT)))
{
$this->master=$props['template'];
}
else 
{
// Master template must exist. Throw error.
show_error('Either you have not provided a master template or the one provided does not exist in <strong>'. APPPATH .'views</strong>. Remember to include the extension if other than ".php"');
}
// Load our regions
if (isset($props['regions']))
{
$this->set_regions($props['regions']);
}
// Set parser and parser method
if (isset($props['parser']))
{
$this->set_parser($props['parser']);
}
if (isset($props['parser_method']))
{
$this->set_parser_method($props['parser_method']);
}
// Set master template parser instructions
$this->parse_template=isset($props['parse_template']) ? $props['parse_template'] : FALSE;
}
// --------------------------------------------------------------------
/**
* Set regions for writing to
*
* @access  public
* @param   array   properly formed regions array
* @return  void
*/
function set_regions($regions)
{
if (count($regions))
{
$this->regions=array(
'_scripts'=> array(),
'_styles'=> array(),
);
foreach ($regions as $key=> $region) 
{
// Regions must be arrays, but we take the burden off the template 
// developer and insure it here
if ( ! is_array($region))
{
$this->add_region($region);
}
else {
$this->add_region($key, $region);
}
}
}
}
// --------------------------------------------------------------------
/**
* Dynamically add region to the currently set template
*
* @access  public
* @param   string   Name to identify the region
* @param   array Optional array with region defaults
* @return  void
*/
function add_region($name, $props=array())
{
if ( ! is_array($props))
{
$props=array();
}
if ( ! isset($this->regions[$name]))
{
$this->regions[$name]=$props;
}
else
{
show_error('The "'. $name .'" region has already been defined.');
}
}
// --------------------------------------------------------------------
/**
* Empty a region's content
*
* @access  public
* @param   string   Name to identify the region
* @return  void
*/
function empty_region($name)
{
if (isset($this->regions[$name]['content']))
{
$this->regions[$name]['content']=array();
}
else
{
show_error('The "'. $name .'" region is undefined.');
}
}
// --------------------------------------------------------------------
/**
* Set parser
*
* @access  public
* @param   string   name of parser class to load and use for parsing methods
* @return  void
*/
function set_parser($parser, $method=NULL)
{
$this->parser=$parser;
$this->CI->load->library($parser);
if ($method)
{
$this->set_parser_method($method);
}
}
// --------------------------------------------------------------------
/**
* Set parser method
*
* @access  public
* @param   string   name of parser class member function to call when parsing
* @return  void
*/
function set_parser_method($method)
{
$this->parser_method=$method;
}
// --------------------------------------------------------------------
/**
* Write contents to a region
*
* @access	public
* @param	string	region to write to
* @param	string	what to write
* @param	boolean	FALSE to append to region, TRUE to overwrite region
* @return	void
*/
function write($region, $content, $overwrite=FALSE)
{
if (isset($this->regions[$region]))
{
if ($overwrite===TRUE) // Should we append the content or overwrite it
{
$this->regions[$region]['content']=array($content);
} else {
$this->regions[$region]['content'][]=$content;
}
}
// Regions MUST be defined
else
{
show_error("Cannot write to the '{$region}' region. The region is undefined.");
}
}
// --------------------------------------------------------------------
/**
* Write content from a View to a region. 'Views within views'
*
* @access	public
* @param	string	region to write to
* @param	string	view file to use
* @param	array	variables to pass into view
* @param	boolean	FALSE to append to region, TRUE to overwrite region
* @return	void
*/
function write_view($region, $view, $data=NULL, $overwrite=FALSE)
{
$args=func_get_args();
// Get rid of non-views
unset($args[0], $args[2], $args[3]);
// Do we have more view suggestions?
if (count($args) > 1)
{
foreach ($args as $suggestion)
{
if (file_exists(APPPATH .'views/'. $suggestion . EXT) or file_exists(APPPATH .'views/'. $suggestion))
{
// Just change the $view arg so the rest of our method works as normal
$view=$suggestion;
break;
}
}
}
$content=$this->CI->load->view($view, $data, TRUE);
$this->write($region, $content, $overwrite);
}
// --------------------------------------------------------------------
/**
* Parse content from a View to a region with the Parser Class
*
* @access  public
* @param   string   region to write to
* @param   string   view file to parse
* @param   array variables to pass into view for parsing
* @param   boolean  FALSE to append to region, TRUE to overwrite region
* @return  void
*/
function parse_view($region, $view, $data=NULL, $overwrite=FALSE)
{
$this->CI->load->library('parser');
$args=func_get_args();
// Get rid of non-views
unset($args[0], $args[2], $args[3]);
// Do we have more view suggestions?
if (count($args) > 1)
{
foreach ($args as $suggestion)
{
if (file_exists(APPPATH .'views/'. $suggestion . EXT) or file_exists(APPPATH .'views/'. $suggestion))
{
// Just change the $view arg so the rest of our method works as normal
$view=$suggestion;
break;
}
}
}
$content=$this->CI->{$this->parser}->{$this->parser_method}($view, $data, TRUE);
$this->write($region, $content, $overwrite);
}
// --------------------------------------------------------------------
/**
* Dynamically include javascript in the template
* 
* NOTE: This function does NOT check for existence of .js file
*
* @access  public
* @param   string   script to import or embed
* @param   string  'import' to load external file or 'embed' to add as-is
* @param   boolean  TRUE to use 'defer' attribute, FALSE to exclude it
* @return  TRUE on success, FALSE otherwise
*/
function add_js($script, $type='import', $defer=FALSE)
{
$success=TRUE;
$js=NULL;
$this->CI->load->helper('url');
switch ($type)
{
case 'import':
$filepath=base_url() . $script;
$js='<script type="text/javascript" src="'. $filepath .'"';
if ($defer)
{
$js .=' defer="defer"';
}
$js .="></script>";
break;
case 'embed':
$js='<script type="text/javascript"';
if ($defer)
{
$js .=' defer="defer"';
}
$js .=">";
$js .=$script;
$js .='</script>';
break;
default:
$success=FALSE;
break;
}
// Add to js array if it doesn't already exist
if ($js !=NULL && !in_array($js, $this->js))
{
$this->js[]=$js;
$this->write('_scripts', $js);
}
return $success;
}
// --------------------------------------------------------------------
/**
* Dynamically include CSS in the template
* 
* NOTE: This function does NOT check for existence of .css file
*
* @access  public
* @param   string   CSS file to link, import or embed
* @param   string  'link', 'import' or 'embed'
* @param   string  media attribute to use with 'link' type only, FALSE for none
* @return  TRUE on success, FALSE otherwise
*/
function add_css($style, $type='link', $media=FALSE)
{
$success=TRUE;
$css=NULL;
$this->CI->load->helper('url');
$filepath=base_url() . $style;
switch ($type)
{
case 'link':
$css='<link type="text/css" rel="stylesheet" href="'. $filepath .'"';
if ($media)
{
$css .=' media="'. $media .'"';
}
$css .=' />';
break;
case 'import':
$css='<style type="text/css">@import url('. $filepath .');</style>';
break;
case 'embed':
$css='<style type="text/css">';
$css .=$style;
$css .='</style>';
break;
default:
$success=FALSE;
break;
}
// Add to js array if it doesn't already exist
if ($css !=NULL && !in_array($css, $this->css))
{
$this->css[]=$css;
$this->write('_styles', $css);
}
return $success;
}
// --------------------------------------------------------------------
/**
* Render the master template or a single region
*
* @access	public
* @param	string	optionally opt to render a specific region
* @param	boolean	FALSE to output the rendered template, TRUE to return as a string. Always TRUE when $region is supplied
* @return	void or string (result of template build)
*/
function render($region=NULL, $buffer=FALSE, $parse=FALSE)
{
// Just render $region if supplied
if ($region) // Display a specific regions contents
{
if (isset($this->regions[$region]))
{
$output=$this->_build_content($this->regions[$region]);
}
else
{
show_error("Cannot render the '{$region}' region. The region is undefined.");
}
}
// Build the output array
else
{
foreach ($this->regions as $name=> $region)
{
$this->output[$name]=$this->_build_content($region);
}
if ($this->parse_template===TRUE or $parse===TRUE)
{
// Use provided parser class and method to render the template
$output=$this->CI->{$this->parser}->{$this->parser_method}($this->master, $this->output, TRUE);
// Parsers never handle output, but we need to mimick it in this case
if ($buffer===FALSE)
{
$this->CI->output->set_output($output);
}
}
else
{
// Use CI's loader class to render the template with our output array
$output=$this->CI->load->view("templates/" .$this->master, $this->output, $buffer);
}
}
return $output;
}
// --------------------------------------------------------------------
/**
* Load the master template or a single region
*
* DEPRECATED!
* 
* Use render() to compile and display your template and regions
*/
function load($region=NULL, $buffer=FALSE)
{
$region=NULL;
$this->render($region, $buffer);
}
// --------------------------------------------------------------------
/**
* Build a region from it's contents. Apply wrapper if provided
*
* @access	private
* @param	string	region to build
* @param	string	HTML element to wrap regions in; like '<div>'
* @param	array	Multidimensional array of HTML elements to apply to $wrapper
* @return	string	Output of region contents
*/
function _build_content($region, $wrapper=NULL, $attributes=NULL)
{
$output=NULL;
// Can't build an empty region. Exit stage left
if ( ! isset($region['content']) or ! count($region['content']))
{
return FALSE;
}
// Possibly overwrite wrapper and attributes
if ($wrapper)
{
$region['wrapper']=$wrapper;
}
if ($attributes)
{
$region['attributes']=$attributes;
}
// Open the wrapper and add attributes
if (isset($region['wrapper'])) 
{
// This just trims off the closing angle bracket. Like '<p>' to '<p'
$output .=substr($region['wrapper'], 0, strlen($region['wrapper']) - 1);
// Add HTML attributes
if (isset($region['attributes']) && is_array($region['attributes']))
{
foreach ($region['attributes'] as $name=> $value)
{
// We don't validate HTML attributes. Imagine someone using a custom XML template..
$output .=" $name=\"$value\"";
}
}
$output .=">";
}
// Output the content items.
foreach ($region['content'] as $content)
{
$output .=$content;
}
// Close the wrapper tag
if (isset($region['wrapper']))
{
// This just turns the wrapper into a closing tag. Like '<p>' to '</p>'
$output .=str_replace('<', '</', $region['wrapper']) . "\n";
}
return $output;
}
}
// END Template Class
/* End of file Template.php */
/* Location: ./system/application/libraries/Template.php */

After creating the template library now let’s move to Settemplate.php file, Here we will write a functions to load the template views.

<?php  if (!defined('BASEPATH')) exit('No direct script access allowed');
class CI_Settemplate 
{   
var $CI ,$ID='',$TYPE;
function CI_SetTemplate()
{
// Copy an instance of CI so we can use the entire framework.
$this->CI=& get_instance();
$this->CI->load->library("template");
}
public function usertemp($view, $data="", $title="Welcome to eknowledgetree")
{
$content=$this->CI->load->view($view, $data, true);
$this->CI->template->set_template('usertemp');
$this->CI->template->write('content',$content);
$stateinfo=$this->CI->load->view("admin/statesinfo",$data,true);
$searchinfo=$this->CI->load->view("admin/searchinfo",$data,true);
$footer=$this->CI->load->view("user/user_footer",$data,true);
$this->CI->template->write ('footer',$footer);
$slider=$this->CI->load->view("user/display_sponseredcars",$data,true);
$this->CI->template->write ('slider',$slider);
$this->CI->template->write('title',$title);
$this->CI->template->write ('stateinfo',$stateinfo);
$this->CI->template->write ('searchinfo',$searchinfo);
$this->CI->template->render();
}
}
?>

Now let’s move to applications->config folder to create template.php file, here we will call the
Template index file, which we need to load at homepage or inner pages.
Let’s create the objects to display Contents, Menu’s and side bars etc.

<?php  if (!defined('BASEPATH')) exit('No direct script access allowed');
/*
|--------------------------------------------------------------------------
| Active template
|--------------------------------------------------------------------------
|
| The $template['active_template'] setting lets you choose which template 
| group to make active.  By default there is only one group (the 
| "default" group).
|
*/
$template['active_template']='usertemp';
/*
|--------------------------------------------------------------------------
| Explaination of template group variables
|--------------------------------------------------------------------------
|
| ['template'] The filename of your master template file in the Views folder.
|   Typically this file will contain a full XHTML skeleton that outputs your
|   full template or region per region. Include the file extension if other
|   than ".php"
| ['regions'] Places within the template where your content may land. 
|   You may also include default markup, wrappers and attributes here 
|   (though not recommended). Region keys must be translatable into variables 
|   (no spaces or dashes, etc)
| ['parser'] The parser class/library to use for the parse_view() method
|   NOTE: See http://codeigniter.com/forums/viewthread/60050/P0/ for a good
|   Smarty Parser that works perfectly with Template
| ['parse_template'] FALSE (default) to treat master template as a View. TRUE
|   to user parser (see above) on the master template
|
| Region information can be extended by setting the following variables:
| ['content'] Must be an array! Use to set default region content
| ['name'] A string to identify the region beyond what it is defined by its key.
| ['wrapper'] An HTML element to wrap the region contents in. (We 
|   recommend doing this in your template file.)
| ['attributes'] Multidimensional array defining HTML attributes of the 
|   wrapper. (We recommend doing this in your template file.)
|
| Example:
| $template['default']['regions']=array(
|    'header'=> array(
|       'content'=> array('<h1>Welcome</h1>','<p>Hello World</p>'),
|       'name'=> 'Page Header',
|       'wrapper'=> '<div>',
|       'attributes'=> array('id'=> 'header', 'class'=> 'clearfix')
|    )
| );
|
*/
/*
|--------------------------------------------------------------------------
| Default Template Configuration (adjust this or create your own)
|--------------------------------------------------------------------------
*/
$template['default']['template']='default';
$template['default']['regions']=array(
'header',
'title',
'content',
'sidebar',
'footer',
'login',
'menu',
'address',
'subtitle',
);
$template['default']['parser']='parser';
$template['default']['parser_method']='parse';
$template['default']['parse_template']=FALSE;
$template['usertemp']['template']='usertemp';
$template['usertemp']['regions']=array(
'header',
'title',
'content',
'sidebar',
'footer',
'slider',
'stateinfo',
'searchinfo',
'login',
'menu',
'address',
'subtitle',
);
$template['usertemp']['parser']='parser';
$template['usertemp']['parser_method']='parse';
$template['usertemp']['parse_template']=FALSE;
//$template['default']['regions']['header']=array('content'=> array('<h1>CI Rocks!</h1>'));
//$template['default']['regions']['footer']=array('content'=> array('<p id="copyright">� Our Company Inc.</p>'));
/* End of file template.php */
/* Location: ./system/application/config/template.php */

Now let’s move to usertemp.php file in the root of codeigniter frame work .
Here we need to call the objects to display content and menu as below.

<!doctype html>
<html>
<head>
<meta charset="UTF-8">
<meta name="description" content="">
<meta name="keywords" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Welcome to Eknowledgetree</title>
<link href="<?php echo base_url();?>css/bootstrap.css" rel="stylesheet" type="text/css">
<link href="<?php echo base_url();?>css/bootstrap-theme.css" rel="stylesheet" type="text/css">
<script src="<?php echo base_url();?>js/jquery.min.js"></script>
</head>
<body>
<!------- top head start --------->
<div class="row drk-blue-bg-wth-border">
<div class="container">
<div class="row">
<div class="col-md-8 top-menu">
<ul>
<li></li>
<li></li>
<li></li>
</ul>
</div>
</div>
</div>
</div>
<!------- top head ends --------->
<!------- menu - logo contaciner starts --------->
<div class="row head-shadow">
<div class="container bg nav-con" id="mainpart">
<div class="row">
<div class="col-md-3">
<a href="<?php echo base_url();?>" target="_self"> <img src="<?php echo base_url();?>images/logo.png" width="200"></a></div>
<div class="col-md-8 pdg0 nav2">
<ul class="nav nav-pills flt-left menu">
<li></li>
<li></li>
<li></li>
<li></li>
<li></li>
<li></li>
</ul>
</div>
<div class="container demo-1">	
<!-- Codrops top bar -->
<!--/ Codrops top bar -->
</div>
</div>
</div>
</div>
<!-------  menu - logo contaciner ends --------->
<!-------  body starts --------->
<div class="body">
<div class="container bg">
<div class="row padding-top-btm pdgb10">
<!-----------left container starts---------->
<div class="col-md-4">
<div class="new-car-con radtl5">
<?php echo $stateinfo;?>
<div class="dvder"></div>
<?php echo $searchinfo; ?>
</div>
<div class="new-car-con radtl5">
<div class="dvder"></div>
<div class="row pad6">
<div class=" txt-centre">
<?php echo $slider; ?>
<?php /*?> <img src="<?php echo base_url();?>images/featred-car.jpg" width="282" height="166"><?php */?> </div>
</div>
</div>
</div>
<div style="clear:both;"></div>
<?php echo $content;?>
</div>
<!-----------right container ends----------> 
</div>
</div>
<!-------  body ends --------->
<!----------- footer starts --------->
<div class="footer pdg0">
<div class="container pdg0">
<div class="footerin col-md-12 pull-left">
<?php echo $footer;?>
<div class="social clear mgnt-40">
<ul>
<li><a href="" class="youtube"></a></li>
<li><a href="" class="twitter"></a></li>
<li><a href="" class="facebook"></a></li>
<li><a href="" class="in"></a></li>
</ul>
</div>
</div>
<div class="row">
<div class="col-md-12 foot-links">
<div class="dvder"></div>
<h6 class="text-center">Copyright 2014 © www.eknowledgetree.com</h6>
</div>
<div class="col-md-4">
</div>	
</div>
</div>
</div>
<!----------- footer ends   --------->   
</body>
</html>

Thanks for reading this article..

READ  Google maps integration with codeigniter

Leave a Reply