CI_DB_Cache Class Reference

List of all members.

Public Member Functions
	CI_DB_Cache (&$db)
	Constructor.
	check_path ($path= '')
	Set Cache Directory Path.
	read ($sql)
	Retrieve a cached query.
	write ($sql, $object)
	Write a query to a cache file.
	delete ($segment_one= '', $segment_two= '')
	Delete cache files within a particular directory.
	delete_all ()
	Delete all existing cache files.
Public Attributes
	$CI
	$db

---

Detailed Description

Definition at line 25 of file DB_cache.php.

---

Member Function Documentation

CI_DB_Cache::check_path

(

$

path = ''

)

Set Cache Directory Path.

public

Parameters:

string

the path to the cache directory

Returns:

bool

Definition at line 54 of file DB_cache.php.

References is_really_writable().

Referenced by read(), and write().

        {
                if ($path == '')
                {
                        if ($this->db->cachedir == '')
                        {
                                return $this->db->cache_off();
                        }
                
                        $path = $this->db->cachedir;
                }
        
                // Add a trailing slash to the path if needed
                $path = preg_replace("/(.+?)\/*$/", "\\1/",  $path);

                if ( ! is_dir($path) OR ! is_really_writable($path))
                {
                        // If the path is wrong we'll turn off caching
                        return $this->db->cache_off();
                }
                
                $this->db->cachedir = $path;
                return TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_DB_Cache::CI_DB_Cache

(

&$

db

)

Constructor.

Grabs the CI super object instance so we can access it.

Definition at line 36 of file DB_cache.php.

References $db, and get_instance().

        {
                // Assign the main CI object to $this->CI
                // and load the file helper since we use it a lot
                $this->CI =& get_instance();
                $this->db =& $db;
                $this->CI->load->helper('file');        
        }

Here is the call graph for this function:

CI_DB_Cache::delete	(	$	segment_one = '',
		$	segment_two = ''
	)

Delete cache files within a particular directory.

public

Returns:

bool

Definition at line 159 of file DB_cache.php.

        {       
                if ($segment_one == '')
                {
                        $segment_one  = ($this->CI->uri->segment(1) == FALSE) ? 'default' : $this->CI->uri->segment(1);
                }
                
                if ($segment_two == '')
                {
                        $segment_two = ($this->CI->uri->segment(2) == FALSE) ? 'index' : $this->CI->uri->segment(2);
                }
                
                $dir_path = $this->db->cachedir.$segment_one.'+'.$segment_two.'/';
                
                delete_files($dir_path, TRUE);
        }

CI_DB_Cache::delete_all

(

)

Delete all existing cache files.

public

Returns:

bool

Definition at line 184 of file DB_cache.php.

        {
                delete_files($this->db->cachedir, TRUE);
        }

CI_DB_Cache::read

(

$

sql

)

Retrieve a cached query.

The URI being requested will become the name of the cache sub-folder. An MD5 hash of the SQL statement will become the cache file name

public

Returns:

string

Definition at line 90 of file DB_cache.php.

References check_path().

        {
                if ( ! $this->check_path())
                {
                        return $this->db->cache_off();
                }
        
                $uri  = ($this->CI->uri->segment(1) == FALSE) ? 'default.'      : $this->CI->uri->segment(1).'+';
                $uri .= ($this->CI->uri->segment(2) == FALSE) ? 'index'         : $this->CI->uri->segment(2);
                
                $filepath = $uri.'/'.md5($sql);
                
                if (FALSE === ($cachedata = read_file($this->db->cachedir.$filepath)))
                {       
                        return FALSE;
                }
                
                return unserialize($cachedata);                 
        }       

Here is the call graph for this function:

CI_DB_Cache::write	(	$	sql,
		$	object
	)

Write a query to a cache file.

public

Returns:

bool

Definition at line 118 of file DB_cache.php.

References check_path().

        {
                if ( ! $this->check_path())
                {
                        return $this->db->cache_off();
                }

                $uri  = ($this->CI->uri->segment(1) == FALSE) ? 'default.'      : $this->CI->uri->segment(1).'+';
                $uri .= ($this->CI->uri->segment(2) == FALSE) ? 'index'         : $this->CI->uri->segment(2);
                
                $dir_path = $this->db->cachedir.$uri.'/';
                
                $filename = md5($sql);
        
                if ( ! @is_dir($dir_path))
                {
                        if ( ! @mkdir($dir_path, DIR_WRITE_MODE))
                        {
                                return FALSE;
                        }
                        
                        @chmod($dir_path, DIR_WRITE_MODE);                      
                }
                
                if (write_file($dir_path.$filename, serialize($object)) === FALSE)
                {
                        return FALSE;
                }
                
                @chmod($dir_path.$filename, DIR_WRITE_MODE);
                return TRUE;
        }

Here is the call graph for this function:

---

Member Data Documentation

CI_DB_Cache::$CI

Definition at line 27 of file DB_cache.php.

CI_DB_Cache::$db

Definition at line 28 of file DB_cache.php.

Referenced by CI_DB_Cache().

---

The documentation for this class was generated from the following file:

• DB_cache.php