Adding audit and finder classes, cleanup and organization

1 files changed, 63 insertions, 0 deletions

diff --git a/classes/backends/IsisDb.php b/classes/backends/IsisDb.php
new file mode 100644
index 0000000..4a2218a
--- /dev/null
+++ b/classes/backends/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 entry id.
+   */
+  public function read($id);
+
+  /**
+   * Return number of entries in the database.
+   *
+   * @return
+   *   Number of entries in the database.
+   */
+  public function entries();
+
+  /**
+   * 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.
+   */
+  static function check($schema, $section = NULL);
+}