diff options
| author | Nathan Guse <nathaniel.guse@gmail.com> | 2012-12-07 21:14:39 -0600 |
|---|---|---|
| committer | Nathan Guse <nathaniel.guse@gmail.com> | 2012-12-07 21:14:39 -0600 |
| commit | 0042f071476b75258f5f8ea0b5b9fcb445ffde23 (patch) | |
| tree | 67cbafd7c655ad94809fef5f7dbe3a23525b232b /phpBB/includes/cache/driver/interface.php | |
| parent | c911a34b5b7541b46ee2408da366d2dc7c302090 (diff) | |
| parent | b7b8fefdd084b51c93b15dfdfb34d2ef294f4d76 (diff) | |
| download | forums-0042f071476b75258f5f8ea0b5b9fcb445ffde23.tar forums-0042f071476b75258f5f8ea0b5b9fcb445ffde23.tar.gz forums-0042f071476b75258f5f8ea0b5b9fcb445ffde23.tar.bz2 forums-0042f071476b75258f5f8ea0b5b9fcb445ffde23.tar.xz forums-0042f071476b75258f5f8ea0b5b9fcb445ffde23.zip | |
Merge branch 'develop' of github.com:EXreaction/phpbb3 into ticket/11103
Conflicts:
phpBB/install/database_update.php
phpBB/styles/prosilver/template/ucp_prefs_personal.html
phpBB/styles/subsilver2/template/ucp_prefs_personal.html
Diffstat (limited to 'phpBB/includes/cache/driver/interface.php')
| -rw-r--r-- | phpBB/includes/cache/driver/interface.php | 47 |
1 files changed, 43 insertions, 4 deletions
diff --git a/phpBB/includes/cache/driver/interface.php b/phpBB/includes/cache/driver/interface.php index 847ba97262..d403bbcd71 100644 --- a/phpBB/includes/cache/driver/interface.php +++ b/phpBB/includes/cache/driver/interface.php @@ -63,42 +63,81 @@ interface phpbb_cache_driver_interface public function destroy($var_name, $table = ''); /** - * Check if a given cache entry exist + * Check if a given cache entry exists */ public function _exists($var_name); /** - * Load cached sql query + * Load result of an SQL query from cache. + * + * @param string $query SQL query + * + * @return int|bool Query ID (integer) if cache contains a rowset + * for the specified query. + * False otherwise. */ public function sql_load($query); /** - * Save sql query + * Save result of an SQL query in cache. + * + * In persistent cache stores, this function stores the query + * result to persistent storage. In other words, there is no need + * to call save() afterwards. + * + * @param string $query SQL query, should be used for generating storage key + * @param mixed $query_result The result from dbal::sql_query, to be passed to + * dbal::sql_fetchrow to get all rows and store them + * in cache. + * @param int $ttl Time to live, after this timeout the query should + * expire from the cache. + * @return int|mixed If storing in cache succeeded, an integer $query_id + * representing the query should be returned. Otherwise + * the original $query_result should be returned. */ public function sql_save($query, $query_result, $ttl); /** - * Ceck if a given sql query exist in cache + * Check if result for a given SQL query exists in cache. + * + * @param int $query_id + * @return bool */ public function sql_exists($query_id); /** * Fetch row from cache (database) + * + * @param int $query_id + * @return array|bool The query result if found in the cache, otherwise + * false. */ public function sql_fetchrow($query_id); /** * Fetch a field from the current row of a cached database result (database) + * + * @param int $query_id + * @param $field The name of the column. + * @return string|bool The field of the query result if found in the cache, + * otherwise false. */ public function sql_fetchfield($query_id, $field); /** * Seek a specific row in an a cached database result (database) + * + * @param int $rownum Row to seek to. + * @param int $query_id + * @return bool */ public function sql_rowseek($rownum, $query_id); /** * Free memory used for a cached database result (database) + * + * @param int $query_id + * @return bool */ public function sql_freeresult($query_id); } |