diff options
| -rw-r--r-- | engine/lib/api.php | 15 | ||||
| -rw-r--r-- | engine/lib/cache.php | 25 | ||||
| -rw-r--r-- | engine/lib/database.php | 4 |
3 files changed, 37 insertions, 7 deletions
diff --git a/engine/lib/api.php b/engine/lib/api.php index 95bbede01..4eb1905b5 100644 --- a/engine/lib/api.php +++ b/engine/lib/api.php @@ -14,8 +14,11 @@ // Result classes ///////////////////////////////////////////////////////////////////////// /** - * @class GenericResult Result superclass. + * GenericResult Result superclass. + * * @author Marcus Povey <marcus@dushka.co.uk> + * @package Elgg + * @subpackage Core */ abstract class GenericResult implements Exportable { @@ -106,9 +109,12 @@ } /** - * @class SuccessResult + * SuccessResult * Generic success result class, extend if you want to do something special. + * * @author Marcus Povey <marcus@dushka.co.uk> + * @package Elgg + * @subpackage Core */ class SuccessResult extends GenericResult { @@ -128,9 +134,12 @@ } /** - * @class ErrorResult + * ErrorResult * The error result class. + * * @author Marcus Povey <marcus@dushka.co.uk> + * @package Elgg + * @subpackage Core */ class ErrorResult extends GenericResult { diff --git a/engine/lib/cache.php b/engine/lib/cache.php index 469042108..9e5a0b1cc 100644 --- a/engine/lib/cache.php +++ b/engine/lib/cache.php @@ -12,9 +12,12 @@ */ /** - * @class ElggCache The elgg cache superclass. + * ElggCache The elgg cache superclass. * This defines the interface for a cache (wherever that cache is stored). + * * @author Marcus Povey <marcus@dushka.co.uk> + * @package Elgg + * @subpackage API */ abstract class ElggCache { @@ -73,9 +76,12 @@ } /** - * @class ElggFileCache + * ElggFileCache * Store cached data in a file store. + * * @author Marcus Povey <marcus@dushka.co.uk> + * @package Elgg + * @subpackage API */ class ElggFileCache extends ElggCache { @@ -134,6 +140,13 @@ return $filename; } + /** + * Save a key + * + * @param string $key + * @param string $data + * @return boolean + */ public function save($key, $data) { $f = $this->create_file($this->sanitise_filename($key), "wb"); @@ -148,6 +161,14 @@ return false; } + /** + * Load a key + * + * @param string $key + * @param int $offset + * @param int $limit + * @return string + */ public function load($key, $offset = 0, $limit = null) { $f = $this->create_file($this->sanitise_filename($key)); diff --git a/engine/lib/database.php b/engine/lib/database.php index e2a92c1cd..045f72c72 100644 --- a/engine/lib/database.php +++ b/engine/lib/database.php @@ -161,7 +161,7 @@ /**
* Use this function to get a single data row from the database
* @param $query The query to run.
- * @result object A single database result object
+ * @return object A single database result object
*/
function get_data_row($query) {
@@ -218,7 +218,7 @@ * Update database data
*
* @param string $query The query to run.
- * @result int|false Either the number of affected rows, or false on failure
+ * @return int|false Either the number of affected rows, or false on failure
*/
function update_data($query) {
|