From 78549556c49e88578d5730ce411c20642f573df6 Mon Sep 17 00:00:00 2001
From: Marcus Pettersen Irgens <marcus.pettersen.irgens@gmail.com>
Date: Wed, 8 Jun 2016 15:50:26 +0200
Subject: [PATCH] First release

---
 README.md                  |  4 +++
 simple-crud/Collection.php | 47 +++++++++++++++++++++++++++
 simple-crud/Database.php   | 55 ++++++++++++++++++++++++++++++++
 simple-crud/Document.php   | 65 ++++++++++++++++++++++++++++++++++++++
 simple-crud/Id.php         | 10 ++++++
 5 files changed, 181 insertions(+)
 create mode 100644 README.md
 create mode 100644 simple-crud/Collection.php
 create mode 100644 simple-crud/Database.php
 create mode 100644 simple-crud/Document.php
 create mode 100644 simple-crud/Id.php

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c96e417
--- /dev/null
+++ b/README.md
@@ -0,0 +1,4 @@
+# SimpleCRUD
+
+*A very simple CRUD interface*
+
diff --git a/simple-crud/Collection.php b/simple-crud/Collection.php
new file mode 100644
index 0000000..f3d5304
--- /dev/null
+++ b/simple-crud/Collection.php
@@ -0,0 +1,47 @@
+<?php
+
+namespace marcuspi\SimpleCRUD;
+
+/**
+ * A collection of documents in a database.
+ */
+interface Collection
+{
+    
+    /**
+     * Creates a new document.
+     * 
+     * @access public
+     * @param array $data
+     * @return Document
+     */
+    public function create($data);
+    
+    /**
+     * Finds a document in the database.
+     * 
+     * @access public
+     * @param Id $id The object's unique identifier
+     * @return Document
+     */
+    public function read(Id $id);
+    
+    /**
+     * Updates the specified document.
+     * 
+     * @access public
+     * @param Id $id The object's unique identifier
+     * @param array $data The data to update
+     * @return int The number of modified objects
+     */
+    public function update(Id $id, $data);
+
+    /**
+     * Removes the specified document.
+     * 
+     * @access public
+     * @param Id $id The object's unique identifier
+     * @return int The number of modified objects
+     */
+    public function delete(Id $id);
+}
\ No newline at end of file
diff --git a/simple-crud/Database.php b/simple-crud/Database.php
new file mode 100644
index 0000000..28d8cea
--- /dev/null
+++ b/simple-crud/Database.php
@@ -0,0 +1,55 @@
+<?php
+    
+namespace marcuspi\SimpleCRUD;
+
+/**
+ * Interface for interacting with a simple document-based database
+ */
+interface Database {
+    
+    /**
+     * Initializes the database.
+     * 
+     * @access public
+     * @static
+     * @param string $path
+     * @return Database
+     */
+    public static function connect($path);
+    
+    /**
+     * Returns the collections in the database.
+     * 
+     * @access public
+     * @return Collection[] An array of Collection objects
+     */
+    public function collections();
+    
+    /**
+     * Returns a specific collection.
+     * 
+     * @access public
+     * @param string $title
+     * @return Collection
+     */
+    public function collection($title);
+    
+    /**
+     * Adds a collection to the database.
+     * 
+     * @access public
+     * @param string $title
+     * @return boolean True if the operation was successful, false otherwise
+     */
+    public function addCollection($title);
+    
+    /**
+     * Removes a collection from the database.
+     * 
+     * @access public
+     * @param string $title
+     * @return boolean True if the operation was successful, false otherwise
+     */
+    public function removeCollection($title);
+    
+}
\ No newline at end of file
diff --git a/simple-crud/Document.php b/simple-crud/Document.php
new file mode 100644
index 0000000..521fa05
--- /dev/null
+++ b/simple-crud/Document.php
@@ -0,0 +1,65 @@
+<?php
+    
+namespace marcuspi\SimpleCRUD;
+
+/**
+ * A document in the database. Objects are stored in an associative array.
+ */
+interface Document {
+    
+    
+    /**
+     * Finds a document in the collection and returns it.
+     * 
+     * @access public
+     * @static
+     * @param Collection $collection The collection to read from
+     * @param Id $id The document's unique identifier
+     * @return Document
+     */
+    public static function restore(Collection $collection, Id $id);
+    
+    /**
+     * Creates a new document in the collection and returns it.
+     * 
+     * @access public
+     * @static
+     * @param Collection $collection The collection to insert into
+     * @param mixed $data The document's unique identifier
+     * @return void
+     */
+    public static function create(Collection $collection, $data);
+    
+    /**
+     * Pulls the contents of this document from the database.
+     * 
+     * @access public
+     * @return void
+     */
+    public function read();
+    
+    /**
+     * Stores changes made to the document.
+     * 
+     * @access public
+     * @return void
+     */
+    public function update();
+    
+    /**
+     * Removes the document from the collection.
+     * 
+     * @access public
+     * @return void
+     */
+    public function delete();
+    
+    /**
+     * Returns the document as an array.
+     * 
+     * @access public
+     * @return void
+     */
+    public function toArray();
+    
+}
\ No newline at end of file
diff --git a/simple-crud/Id.php b/simple-crud/Id.php
new file mode 100644
index 0000000..28f5ac5
--- /dev/null
+++ b/simple-crud/Id.php
@@ -0,0 +1,10 @@
+<?php
+    
+namespace marcuspi\SimpleCRUD;
+
+interface Id
+{
+    public static function make();
+    
+    public static function restore($id);
+}
\ No newline at end of file