From 5aa8a70b0b5fdaafd9395166b32e4111758b9305 Mon Sep 17 00:00:00 2001
From: Timothy J Warren <tim@timshomepage.net>
Date: Fri, 1 Apr 2016 17:35:53 -0400
Subject: [PATCH] Start of interface for caching backend

---
 src/Aviat/Ion/Cache/CacheDriverInterface.php | 36 ++++++++++++++++++++
 src/Aviat/Ion/Cache/CacheInterface.php       | 31 +++++++++++++++++
 2 files changed, 67 insertions(+)
 create mode 100644 src/Aviat/Ion/Cache/CacheDriverInterface.php
 create mode 100644 src/Aviat/Ion/Cache/CacheInterface.php

diff --git a/src/Aviat/Ion/Cache/CacheDriverInterface.php b/src/Aviat/Ion/Cache/CacheDriverInterface.php
new file mode 100644
index 00000000..4c45ba3f
--- /dev/null
+++ b/src/Aviat/Ion/Cache/CacheDriverInterface.php
@@ -0,0 +1,36 @@
+<?php
+/**
+ * Ion
+ *
+ * Building blocks for web development
+ *
+ * @package     Ion
+ * @author      Timothy J. Warren
+ * @copyright   Copyright (c) 2015 - 2016
+ * @license     MIT
+ */
+
+namespace Aviat\Ion\Cache;
+
+/**
+ * Interface for cache drivers
+ */
+interface CacheDriverInterface {
+    /**
+     * Retreive a value from the cache backend
+     *
+     * @param string $key
+     * @return mixed
+     */
+    public function get($key);
+
+    /**
+     * Set a cached value
+     *
+     * @param string $key
+     * @param mixed $value
+     * @return CacheDriverInterface
+     */
+    public function set($key, $value);
+}
+// End of CacheDriverInterface.php
\ No newline at end of file
diff --git a/src/Aviat/Ion/Cache/CacheInterface.php b/src/Aviat/Ion/Cache/CacheInterface.php
new file mode 100644
index 00000000..7b93bc30
--- /dev/null
+++ b/src/Aviat/Ion/Cache/CacheInterface.php
@@ -0,0 +1,31 @@
+<?php
+/**
+ * Ion
+ *
+ * Building blocks for web development
+ *
+ * @package     Ion
+ * @author      Timothy J. Warren
+ * @copyright   Copyright (c) 2015 - 2016
+ * @license     MIT
+ */
+
+namespace Aviat\Ion\Cache;
+
+/**
+ * Interface for retrieving values from cache
+ */
+interface CacheInterface {
+	
+	/**
+	 * Retreive a cached value if it exists, otherwise, get the value
+	 * from the passed arguments
+	 *
+	 * @param object $object - object to retrieve fresh value from
+	 * @param string $method - method name to call
+	 * @param array $args - the arguments to pass to the retrieval method
+	 * @return mixed - the cached or fresh data
+	 */ 
+	public function get($object, $method, array $args);
+}
+// End of CacheInterface.php
\ No newline at end of file