diff options
| author | Oleg Pudeyev <oleg@bsdpower.com> | 2012-11-30 12:04:05 -0500 |
|---|---|---|
| committer | Oleg Pudeyev <oleg@bsdpower.com> | 2012-11-30 12:04:05 -0500 |
| commit | 3eb15ab59e202f6d995f40da7cbee0056e73f5d1 (patch) | |
| tree | 05edf87e1418bc55f3be496c22b27420a5436e86 /phpBB/includes/cache | |
| parent | ee16ed7b76315f629adc1f234d6cf3ddd9552a97 (diff) | |
| download | forums-3eb15ab59e202f6d995f40da7cbee0056e73f5d1.tar forums-3eb15ab59e202f6d995f40da7cbee0056e73f5d1.tar.gz forums-3eb15ab59e202f6d995f40da7cbee0056e73f5d1.tar.bz2 forums-3eb15ab59e202f6d995f40da7cbee0056e73f5d1.tar.xz forums-3eb15ab59e202f6d995f40da7cbee0056e73f5d1.zip | |
[ticket/10875] More documentation.
PHPBB3-10875
Diffstat (limited to 'phpBB/includes/cache')
| -rw-r--r-- | phpBB/includes/cache/driver/interface.php | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/phpBB/includes/cache/driver/interface.php b/phpBB/includes/cache/driver/interface.php index 26dfd497aa..d403bbcd71 100644 --- a/phpBB/includes/cache/driver/interface.php +++ b/phpBB/includes/cache/driver/interface.php @@ -68,7 +68,7 @@ interface phpbb_cache_driver_interface public function _exists($var_name); /** - * Load cached sql query + * Load result of an SQL query from cache. * * @param string $query SQL query * @@ -79,7 +79,11 @@ interface phpbb_cache_driver_interface 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 @@ -94,7 +98,7 @@ interface phpbb_cache_driver_interface public function sql_save($query, $query_result, $ttl); /** - * Check if a given sql query exists in cache + * Check if result for a given SQL query exists in cache. * * @param int $query_id * @return bool |