diff options
| author | Andrey Andreev <narf@bofh.bg> | 2012-11-02 00:42:31 +0100 |
|---|---|---|
| committer | Andrey Andreev <narf@bofh.bg> | 2012-11-02 00:42:31 +0100 |
| commit | ae85eb42aa2d5c6d9a41b3cf6c61a4bf1c9b0566 (patch) | |
| tree | a58f3f659e53d5bc29b4c17e7e3d90fbb267f5dc /system/database/DB_cache.php | |
| parent | f5ccd12b395a6d01c8ba1890f3639b753a345379 (diff) | |
DocBlocks for base DB classes
Partially fixes issue #1295.
Diffstat (limited to 'system/database/DB_cache.php')
| -rw-r--r-- | system/database/DB_cache.php | 26 |
1 files changed, 21 insertions, 5 deletions
diff --git a/system/database/DB_cache.php b/system/database/DB_cache.php index 37d2dd0b5..b8f8995fa 100644 --- a/system/database/DB_cache.php +++ b/system/database/DB_cache.php @@ -35,8 +35,24 @@ defined('BASEPATH') OR exit('No direct script access allowed'); */ class CI_DB_Cache { + /** + * CI Singleton + * + * @var object + */ public $CI; - public $db; // allows passing of db object so that multiple database connections and returned db objects can be supported + + /** + * Database object + * + * Allows passing of DB object so that multiple database connections + * and returned DB objects can be supported. + * + * @var object + */ + public $db; + + // -------------------------------------------------------------------- /** * Constructor @@ -59,7 +75,7 @@ class CI_DB_Cache { /** * Set Cache Directory Path * - * @param string the path to the cache directory + * @param string $path Path to the cache directory * @return bool */ public function check_path($path = '') @@ -95,7 +111,7 @@ class CI_DB_Cache { * Retrieve a cached query * * The URI being requested will become the name of the cache sub-folder. - * An MD5 hash of the SQL statement will become the cache file name + * An MD5 hash of the SQL statement will become the cache file name. * * @param string $sql * @return string @@ -154,8 +170,8 @@ class CI_DB_Cache { /** * Delete cache files within a particular directory * - * @param string $segment_one = '' - * @param string $segment_two = '' + * @param string $segment_one + * @param string $segment_two * @return void */ public function delete($segment_one = '', $segment_two = '') |