From b30bac3f31c602fd2cb3a9b2a03501a68a9c7800 Mon Sep 17 00:00:00 2001
From: Silvio <silvio@devlet.com.br>
Date: Mon, 7 Jun 2010 17:31:58 -0300
Subject: Sorting code

---
 classes/IsisDb.php | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 classes/IsisDb.php

(limited to 'classes/IsisDb.php')

diff --git a/classes/IsisDb.php b/classes/IsisDb.php
new file mode 100644
index 0000000..1e63f38
--- /dev/null
+++ b/classes/IsisDb.php
@@ -0,0 +1,63 @@
+<?php
+
+/**
+ * Generic interface for reading Isis databases.
+ */
+interface IsisDb {
+  /**
+   * Constructor.
+   *
+   * The implementation constructor should accept a database
+   * schema definition and setup the appropriate db resource.
+   *
+   * @param $schema
+   *   High level database schema description.
+   *
+   * @return
+   *   Database resource or FALSE in case of error.
+   *
+   * @see default_schema()
+   */
+  public function __construct($schema);
+
+  /**
+   * Read an entry from the database.
+   *
+   * @param $id
+   *   Database row id.
+   */
+  public function read($id);
+
+  /**
+   * Return number of rows in the database.
+   *
+   * @return
+   *   Number of rows in the database.
+   */
+  public function rows();
+
+  /**
+   * Return an example database schema.
+   *
+   * The example schema should have all information the implementation
+   * needs to be able to open and read a database.
+   *
+   * @return
+   *   Array with a sample database schema.
+   */
+  public function example();
+
+  /**
+   * Configuration check.
+   *
+   * @param $schema
+   *   Database schema to check.
+   *
+   * @param $section
+   *   Configuration section.
+   *
+   * @return
+   *   Database schema or FALSE if error.
+   */
+  function check($schema, $section = NULL);
+}
-- 
cgit v1.2.3