FileBackedCache Class Reference

Provides a simple File-backed caching implementation for when no shared memory caching extension is present, but the application has access to a writeable folder. More...

Public Member Functions
	FileBackedCache ()
	keyToFile ($key)
	get ($key)
	put ($key, $obj, $ttl=0)
	invalidate ($key)
	invalidateMatching ($pattern)
	clear ()

Public Attributes
	$cache
	$cacheDir

Detailed Description

Provides a simple File-backed caching implementation for when no shared memory caching extension is present, but the application has access to a writeable folder.

This is NOT recommended for high-volume sites, but may be your only option on a shared server.

Definition at line 444 of file cache.inc.

Member Function Documentation

clear()

FileBackedCache::clear

(

)

Definition at line 526 of file cache.inc.

     {
          foreach(glob($this->cacheDir . DIRECTORY_SEPARATOR . "*.txt") as $doomed)
          {
               unlink($doomed);
          } 
     }

FileBackedCache()

FileBackedCache::FileBackedCache

(

)

Definition at line 449 of file cache.inc.

     {
          global $config;
          
          trace("Creating File-backed Cache", 4);
          
          $this->cacheDir = $config["file_backed_cache_directory"];
          $this->cache = array();
          
          trace("Cache Directory: {$this->cacheDir}", 3);
     }

get()

FileBackedCache::get

(

$key

)

Definition at line 466 of file cache.inc.

     {
          if (array_key_exists($key, $this->cache)) return $this->cache[$key];
          $file = $this->keyToFile($key);
          if (file_exists($file))
          {
               $c = unserialize(file_get_contents($file));
               $this->cache[$key] = $c;
               return $c;
          }
          else return null;
     }

invalidate()

FileBackedCache::invalidate

(

$key

)

Definition at line 512 of file cache.inc.

     {
          $file = $this->keyToFile($key);
 
          if (file_exists($file)) unlink($file);
          unset($this->cache[$key]);
          return true;
     }

invalidateMatching()

FileBackedCache::invalidateMatching

(

$pattern

)

Definition at line 521 of file cache.inc.

     {
          throw new FakoliException("FileBackedCache currently does not support the invalidateMatching() method");
     }

keyToFile()

FileBackedCache::keyToFile

(

$key

)

Definition at line 461 of file cache.inc.

     {
          return $this->cacheDir . DIRECTORY_SEPARATOR . $key . ".txt";
     }

put()

FileBackedCache::put	(		$key,
			$obj,
			$ttl = 0
	)

Definition at line 479 of file cache.inc.

     {
          $this->cache[$key] = $obj;
          
          $file = $this->keyToFile($key);
          
          if (!file_exists($file))
          {
               $fp = fopen($file, "w");
               fwrite($fp, serialize($obj));
               fclose($fp);
          }
          else
          {
               $fp = fopen($file, "w+");
     
               if (flock($fp, LOCK_EX)) 
               {
                   ftruncate($fp, 0);
                   fwrite($fp, serialize($obj));
                   flock($fp, LOCK_UN);
               } 
               else 
               {
                   echo "Couldn't get the lock!";
               }
          }
          fclose($fp);
          
          return true;
          // NOTE - ttl is ignored if using in-memory caching.
     }

Member Data Documentation

$cache

FileBackedCache::$cache

Definition at line 446 of file cache.inc.

$cacheDir

FileBackedCache::$cacheDir

Definition at line 447 of file cache.inc.

---

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

• C:/code/cms.sonjara.com/framework/cache.inc