Merge pull request #23 from Vinai/improve-cache-service

Improve the process of clearing the cache.

Author: Alistair Stead

src/MageTest/MagentoExtension/Service/Cache/BaseCache.php

@@ -0,0 +1,82 @@
+<?php
+/**
+ * BehatMage
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the MIT License, that is bundled with this
+ * package in the file LICENSE.
+ * It is also available through the world-wide-web at this URL:
+ *
+ * http://opensource.org/licenses/MIT
+ *
+ * If you did not receive a copy of the license and are unable to obtain it
+ * through the world-wide-web, please send an email
+ * to <magetest@sessiondigital.com> so we can send you a copy immediately.
+ *
+ * @category   MageTest
+ * @package    MagentoExtension
+ * @subpackage Service\Cache
+ *
+ * @copyright  Copyright (c) 2012-2013 MageTest team and contributors.
+ */
+namespace MageTest\MagentoExtension\Service\Cache;
+
+use Mage_Core_Model_App;
+
+/**
+ * ConfigurationCache
+ *
+ * @category   MageTest
+ * @package    MagentoExtension
+ * @subpackage Service\Cache
+ *
+ * @author     MageTest team (https://github.com/MageTest/BehatMage/contributors)
+ */
+abstract class BaseCache
+{
+    /**
+     * List of cache types to clear.
+     *
+     * For example:
+     * - config
+     * - block_html
+     * - layout
+     * - translate
+     *
+     * @var array
+     */
+    protected $cacheTypes = array();
+
+    /**
+     * Internal instance of MageApp
+     *
+     * @var Mage_Core_Model_App
+     **/
+    protected $mageApp;
+
+
+    public function __construct(Mage_Core_Model_App $mageApp)
+    {
+        $this->mageApp = $mageApp;
+    }
+
+    public function clear()
+    {
+        $this->mageApp->cleanCache($this->getCacheTags());
+    }
+
+    /**
+     * All listed types must be declared under global/cache/types
+     *
+     * @return array
+     */
+    private function getCacheTags()
+    {
+        $tags = array();
+        foreach ($this->cacheTypes as $type) {
+            $tags = array_merge($tags, $this->mageApp->getCacheInstance()->getTagsByType($type));
+        }
+        return $tags;
+    }
+}

src/MageTest/MagentoExtension/Service/Cache/BlockHtmlCache.php

@@ -0,0 +1,37 @@
+<?php
+/**
+ * BehatMage
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the MIT License, that is bundled with this
+ * package in the file LICENSE.
+ * It is also available through the world-wide-web at this URL:
+ *
+ * http://opensource.org/licenses/MIT
+ *
+ * If you did not receive a copy of the license and are unable to obtain it
+ * through the world-wide-web, please send an email
+ * to <magetest@sessiondigital.com> so we can send you a copy immediately.
+ *
+ * @category   MageTest
+ * @package    MagentoExtension
+ * @subpackage Service\Cache
+ *
+ * @copyright  Copyright (c) 2012-2013 MageTest team and contributors.
+ */
+namespace MageTest\MagentoExtension\Service\Cache;
+
+/**
+ * ConfigurationCache
+ *
+ * @category   MageTest
+ * @package    MagentoExtension
+ * @subpackage Service\Cache
+ *
+ * @author     MageTest team (https://github.com/MageTest/BehatMage/contributors)
+ */
+class BlockHtmlCache extends BaseCache
+{
+    protected $cacheTypes = array('block_html');
+}

src/MageTest/MagentoExtension/Service/Cache/ConfigurationCache.php

@@ -22,8 +22,6 @@
  */
 namespace MageTest\MagentoExtension\Service\Cache;
 
-use Mage_Core_Model_App;
-
 /**
  * ConfigurationCache
  *
@@ -33,23 +31,7 @@
  *
  * @author     MageTest team (https://github.com/MageTest/BehatMage/contributors)
  */
-class ConfigurationCache
+class ConfigurationCache extends BaseCache
 {
-    /**
-     * Internal instance of MageApp
-     *
-     * @var Mage_Core_Model_App
-     **/
-    private $mageApp;
-
-    public function __construct(Mage_Core_Model_App $mageApp)
-    {
-        $this->mageApp = $mageApp;
-    }
-
-    // FIXME This is brutal but it is late
-    public function clear()
-    {
-        $this->mageApp->getCacheInstance()->flush();
-    }
+    protected $cacheTypes = array('config');
 }

src/MageTest/MagentoExtension/Service/Cache/LayoutCache.php

@@ -0,0 +1,37 @@
+<?php
+/**
+ * BehatMage
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the MIT License, that is bundled with this
+ * package in the file LICENSE.
+ * It is also available through the world-wide-web at this URL:
+ *
+ * http://opensource.org/licenses/MIT
+ *
+ * If you did not receive a copy of the license and are unable to obtain it
+ * through the world-wide-web, please send an email
+ * to <magetest@sessiondigital.com> so we can send you a copy immediately.
+ *
+ * @category   MageTest
+ * @package    MagentoExtension
+ * @subpackage Service\Cache
+ *
+ * @copyright  Copyright (c) 2012-2013 MageTest team and contributors.
+ */
+namespace MageTest\MagentoExtension\Service\Cache;
+
+/**
+ * ConfigurationCache
+ *
+ * @category   MageTest
+ * @package    MagentoExtension
+ * @subpackage Service\Cache
+ *
+ * @author     MageTest team (https://github.com/MageTest/BehatMage/contributors)
+ */
+class LayoutCache extends BaseCache
+{
+    protected $cacheTypes = array('layout');
+}