From 9329b16ab13f3a4caf107df358c3c58bda2dcd8a Mon Sep 17 00:00:00 2001
From: Igor Wiedler <igor@wiedler.ch>
Date: Wed, 3 Nov 2010 18:35:31 +0100
Subject: [task/acm-refactor] Refactor the ACM classes to have a common
 interface.

They are now refered to as cache drivers rather than ACM classes. The
additional utility functions from the original cache class have been
moved to the cache_service. The class loader is now instantiated without
a cache instance and passed one as soon as it is constructed to allow
autoloading the cache classes.

PHPBB3-9983
---
 phpBB/includes/cache/driver/interface.php | 104 ++++++++++++++++++++++++++++++
 1 file changed, 104 insertions(+)
 create mode 100644 phpBB/includes/cache/driver/interface.php

(limited to 'phpBB/includes/cache/driver/interface.php')

diff --git a/phpBB/includes/cache/driver/interface.php b/phpBB/includes/cache/driver/interface.php
new file mode 100644
index 0000000000..91d364abf6
--- /dev/null
+++ b/phpBB/includes/cache/driver/interface.php
@@ -0,0 +1,104 @@
+<?php
+/**
+*
+* @package acm
+* @copyright (c) 2010 phpBB Group
+* @license http://opensource.org/licenses/gpl-license.php GNU Public License
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+/**
+* An interface that all cache drivers must implement
+*
+* @package acm
+*/
+interface phpbb_cache_driver_interface
+{
+	/**
+	* Load global cache
+	*/
+	public function load();
+
+	/**
+	* Unload cache object
+	*/
+	public function unload();
+
+	/**
+	* Save modified objects
+	*/
+	public function save();
+
+	/**
+	* Tidy cache
+	*/
+	public function tidy();
+
+	/**
+	* Get saved cache object
+	*/
+	public function get($var_name);
+
+	/**
+	* Put data into cache
+	*/
+	public function put($var_name, $var, $ttl = 0);
+
+	/**
+	* Purge cache data
+	*/
+	public function purge();
+
+	/**
+	* Destroy cache data
+	*/
+	public function destroy($var_name, $table = '');
+
+	/**
+	* Check if a given cache entry exist
+	*/
+	public function _exists($var_name);
+
+	/**
+	* Load cached sql query
+	*/
+	public function sql_load($query);
+
+	/**
+	* Save sql query
+	*/
+	public function sql_save($query, &$query_result, $ttl);
+
+	/**
+	* Ceck if a given sql query exist in cache
+	*/
+	public function sql_exists($query_id);
+
+	/**
+	* Fetch row from cache (database)
+	*/
+	public function sql_fetchrow($query_id);
+
+	/**
+	* Fetch a field from the current row of a cached database result (database)
+	*/
+	public function sql_fetchfield($query_id, $field);
+
+	/**
+	* Seek a specific row in an a cached database result (database)
+	*/
+	public function sql_rowseek($rownum, $query_id);
+
+	/**
+	* Free memory used for a cached database result (database)
+	*/
+	public function sql_freeresult($query_id);
+}
-- 
cgit v1.2.1