diff options
| author | Joas Schilling <nickvergessen@gmx.de> | 2012-12-20 22:51:38 +0100 |
|---|---|---|
| committer | Joas Schilling <nickvergessen@gmx.de> | 2012-12-20 22:51:38 +0100 |
| commit | e34b8ed094affdaedbf457406c98b29c125e5d8b (patch) | |
| tree | 7cc51ba4ead71cb48a76747770edf622f8fe85f9 /phpBB/includes/cache/driver/interface.php | |
| parent | 70a409d4b5411bf9e50a70d1cf3855b686304bbe (diff) | |
| parent | d11829567603e6ac37170b919efc4659b2be20cb (diff) | |
| download | forums-e34b8ed094affdaedbf457406c98b29c125e5d8b.tar forums-e34b8ed094affdaedbf457406c98b29c125e5d8b.tar.gz forums-e34b8ed094affdaedbf457406c98b29c125e5d8b.tar.bz2 forums-e34b8ed094affdaedbf457406c98b29c125e5d8b.tar.xz forums-e34b8ed094affdaedbf457406c98b29c125e5d8b.zip | |
Merge branch 'develop' of https://github.com/phpbb/phpbb3 into feature/softdelete-1-permission-rebase
* 'develop' of https://github.com/phpbb/phpbb3: (544 commits)
[feature/events] Fix improperly named event in documentation
[feature/events] Fix alphabetization of events
[feature/events] Put events in alphabetical order
[feature/events] Make EVENTS.md lowercase
[ticket/11285] Use more granularity in dependency checks in compress test
[ticket/10880] The m_approve permisson no longer implies f_noapprove.
[ticket/10803] Show failure message until user dismisses it
[ticket/10954] Add missing semi-colon
[ticket/10954] Make sure to mark subforums unread and add small fixes
[feature/events] Use ` to escape HTML tags in markdown
[feature/events] Remove HTML tags from markdown so they don't get parsed
[ticket/10954] Miscellaneous coding fixes
[feature/events] Remove extraneous space
[feature/events] Add markdown template event documentation file
[feature/events] forumlist_body_last_post_title_after -> _prepend (subsilver2)
[feature/events] Fix overall_footer_end -> overall_footer_after (subsilver2)
[feature/events] Fix typo in event name
[ticket/10763] Use self when calling get_extension() in filespec class
[feature/events] Fix more subsilver2 events
[feature/events] Fix some subsilver2 events
...
Conflicts:
phpBB/install/database_update.php
phpBB/posting.php
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); } |