diff options
Diffstat (limited to 'interface.php')
-rw-r--r-- | interface.php | 33 |
1 files changed, 26 insertions, 7 deletions
diff --git a/interface.php b/interface.php index 5ba5a55..f5802d7 100644 --- a/interface.php +++ b/interface.php @@ -1,21 +1,40 @@ <?php -/** - * Database procedures. - */ /** * Generic interface for reading Isis databases. */ interface IsisDb { - // Constructor. + /** + * Constructor. + * + * @param $schema + * High level database schema description. + * + * @see default_schema() + */ public function __construct($schema); - // Read an entry. + /** + * Read an entry. + * + * @param $id + * Database row id. + */ public function read($id); - // Return number of rows in the database. + /** + * Return number of rows in the database. + * + * @return + * Number of rows in the database. + */ public function rows(); - // Return a default example schema. + /** + * Return a default example schema. + * + * @return + * Array with a sample database schema. + */ public function default_schema(); } |