makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-28 14:18:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/10875] More documentation.

Browse source 
PHPBB3-10875
This commit is contained in:
Oleg Pudeyev 2012-11-30 12:04:05 -05:00
parent ee16ed7b76
commit 3eb15ab59e
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
phpBB/includes/cache/driver/interface.php vendored
View file

@ -68,7 +68,7 @@ interface phpbb_cache_driver_interface
public function _exists($var_name); public function _exists($var_name);
/** /**
* Load cached sql query * Load result of an SQL query from cache.
* *
* @param string $query SQL query * @param string $query SQL query
* *
@ -79,7 +79,11 @@ interface phpbb_cache_driver_interface
public function sql_load($query); 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 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 * @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); 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 * @param int $query_id
* @return bool * @return bool