template.php

Go to the documentation of this file.

<?php
/*~ template.php
.---------------------------------------------------------------------------.
|  Software: SencilloCache                                                  |
|   Version: 2014.002                                                       |
|   Contact: [email protected]                                                  |
| ------------------------------------------------------------------------- |
|    Author: Bc. Peter Horváth (original founder)                           |
| Copyright (c) 2014, Bc. Peter Horváth. All Rights Reserved.               |
| ------------------------------------------------------------------------- |
|   License: Distributed under the General Public License (GPL)             |
|            http://www.gnu.org/copyleft/gpl.html                           |
| This program is distributed in the hope that it will be useful - WITHOUT  |
| ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or     |
| FITNESS FOR A PARTICULAR PURPOSE.                                         |
'---------------------------------------------------------------------------'
~*/

/* Template for other types of cache
 * You'll need to implement these 5 functions, add
 * additional functions inhere.
 *
 * Add variables you use to quickcache_config.php
 *
 * When you've implemented a new storage-system, and think that the world
 * could/should use it too, please submit it to me ([email protected]),
 * and we will include it in a next release (with full credits, of course).
 */

/* quickcache_restore()
 * Will (try to) restore the cachedata.
 */
function quickcache_restore() {
  global $QUICKCACHE_TIME, $cache_key, $cachedata_gzdata, $cachedata_datasize, $cachedata_datacrc;

  // Implement restoring of cached data
  //
  // Use $cache_key to lookup data, use $JPACHE_TIME to check if
  // data is still valid.
  //
  // If data-retrieval was succesfull, you'll need to set
  // $cachedata_gzdata, $cachedata_datasize and $cachedata_datacrc
  // and return true, if unsuccesfull, return false.

  return false;
}

/* quickcache_write()
 * Will (try to) write out the cachedata to the db
 */
function quickcache_write($gzcontents, $size, $crc32) {
  global $QUICKCACHE_TIME, $QUICKCACHE_ON, $cache_key;

  // Implement writing of the data as given.
  // Store on $cache_key and add a 'field' for $QUICKCACHE_TIME
  // Store the 3 parameters seperatly
}

/* quickcache_do_gc()
 * Performs the actual garbagecollection
 */
function quickcache_do_gc() {
  // Implement garbage-collection
}


/* quickcache_do_start()
 * Additional code that is executed before real quickcache-code kicks
 */
function quickcache_do_start() {
  // Add additional code you might require
}

/* quickcache_do_end()
 * Additional code that us executed after caching has been performed,
 * but just before output is returned. No new output can be added.
 */
function quickcache_do_end() {
  // Add additional code you might require
}

// Make sure no additional lines/characters are after the closing-tag!
?>