Merge pull request #24 from ruff/filesystem-cache

Add disk cache.

src/Handlebars/Cache/Disk.php

@@ -0,0 +1,117 @@
+<?php
+/**
+ * This file is part of Handlebars-php
+ * Base on mustache-php https://github.com/bobthecow/mustache.php
+ *
+ * PHP version 5.3
+ *
+ * @category  Xamin
+ * @package   Handlebars
+ * @author    Alex Soncodi <alex@brokerloop.com>
+ * @copyright 2013 (c) Brokerloop, Inc.
+ * @license   MIT <http://opensource.org/licenses/MIT>
+ * @version   GIT: $Id$
+ * @link      http://xamin.ir
+ */
+
+
+/**
+ * A flat-file filesystem cache.
+ *
+ * @category  Xamin
+ * @package   Handlebars
+ * @author    Alex Soncodi <alex@brokerloop.com>
+ * @copyright 2013 (c) Brokerloop, Inc.
+ * @license   MIT <http://opensource.org/licenses/MIT>
+ * @version   Release: @package_version@
+ * @link      http://xamin.ir
+ */
+
+class Handlebars_Cache_Disk implements Handlebars_Cache
+{
+    private $_path = '';
+    private $_prefix = '';
+    private $_suffix = '';
+
+    /**
+     * Construct the disk cache.
+     *
+     * @param string $path Filesystem path to the disk cache location
+     * @param string $prefix optional file prefix, defaults to empty string
+     * @param string $suffix optional file extension, defaults to empty string
+     */
+    public function __construct($path, $prefix = '', $suffix = '')
+    {
+        if (empty($path)) {
+            throw new InvalidArgumentException('Must specify disk cache path');
+        }
+        else if (!is_dir($path)) {
+            @mkdir($path, 0777, true);
+
+            if (!is_dir($path)) {
+                throw new RuntimeException('Could not create cache file path');
+            }
+        }
+
+        $this->_path = $path;
+        $this->_prefix = $prefix;
+        $this->_suffix = $suffix;
+    }
+
+    /**
+     * Gets the full disk path for a given cache item's file,
+     * taking into account the cache path, optional prefix,
+     * and optional extension.
+     *
+     * @param string $name Name of the cache item
+     */
+    private function getPath($name)
+    {
+        return $this->_path . DIRECTORY_SEPARATOR .
+            $this->_prefix . $name . $this->_suffix;
+    }
+
+    /**
+     * Get cache for $name if it exists.
+     *
+     * @param string $name Cache id
+     *
+     * @return data on hit, boolean false on cache not found
+     */
+    public function get($name)
+    {
+        $path = $this->getPath($name);
+
+        return (file_exists($path)) ?
+            unserialize(file_get_contents($path)) : false;
+    }
+
+    /**
+     * Set a cache
+     *
+     * @param string $name  cache id
+     * @param mixed  $value data to store
+     *
+     * @return void
+     */
+    public function set($name, $value)
+    {
+        $path = $this->getPath($name);
+
+        file_put_contents($path, serialize($value));
+    }
+
+    /**
+     * Remove cache
+     *
+     * @param string $name Cache id
+     *
+     * @return void
+     */
+    public function remove($name)
+    {
+        $path = $this->getPath($name);
+
+        unlink($path);
+    }
+}