Adding caching capabilities implemented in php-tmdb-api

Author: wtfzdotnet

DependencyInjection/Configuration.php

@@ -23,6 +23,12 @@ public function getConfigTreeBuilder()
         $rootNode
             ->children()
                 ->scalarNode('api_key')->end()
+                ->arrayNode('cache')
+                    ->children()
+                        ->scalarNode('enabled')->end()
+                        ->scalarNode('path')->end()
+                    ->end()
+                ->end()
             ->end()
         ;
 

DependencyInjection/WtfzTmdbExtension.php

@@ -31,9 +31,14 @@ public function load(array $configs, ContainerBuilder $container)
             );
         }
 
-        $container->setParameter(
-            'wtfz_tmdb.api_key',
-            $config['api_key']
-        );
+        $container->setParameter('wtfz_tmdb.api_key', $config['api_key']);
+
+        if (array_key_exists('cache', $config)) {
+            $cacheEnabled = array_key_exists('enabled', $config['cache']) && $config['cache']['enabled'];
+            $cachePath    = array_key_exists('path', $config['cache']) ? $config['cache']['path'] : null;
+
+            $container->setParameter('wtfz_tmdb.cache.enabled', $cacheEnabled);
+            $container->setParameter('wtfz_tmdb.cache.path', $cachePath);
+        }
     }
 }

README.md

@@ -19,6 +19,19 @@ wtfz_tmdb:
 
 That's all! Fire away!
 
+** Want to make use of default caching? **
+
+This caching system will adhere to the TMDB API max-age values, if you have different needs like long TTL's
+you'd have to make your own implementation. We would be happy to intergrate more options, so please contribute.
+
+```yaml
+wtfz_tmdb:
+    api_key: YOUR_API_KEY_HERE
+    cache:
+        enabled: true
+        path: "/tmp/php-tmdb-api"
+```
+
 __There will be adult and language filters coming in a later stage, so later on the configuration will look like:__
 
 ```yaml

Resources/config/tmdb.xml

@@ -5,13 +5,20 @@
     xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
     <parameters>
+        <!-- Options parameters -->
         <parameter key="wtfz_tmdb.api_key" />
+        <parameter key="wtfz_tmdb.cache.enabled" />
+        <parameter key="wtfz_tmdb.cache.path" />
 
         <!-- Main classes -->
-        <parameter key="wtfz_tmdb.api_token.class">Tmdb\ApiToken</parameter>
         <parameter key="wtfz_tmdb.client.class">Tmdb\Client</parameter>
+        <parameter key="wtfz_tmdb.api_token.class">Tmdb\ApiToken</parameter>
+        <parameter key="wtfz_tmdb.request_token.class">Tmdb\RequestToken</parameter>
+        <parameter key="wtfz_tmdb.session_token.class">Tmdb\SessionToken</parameter>
 
         <!-- Repository classes -->
+        <parameter key="wtfz_tmdb.authentication_repository.class">Tmdb\Repository\AuthenticationRepository</parameter>
+        <parameter key="wtfz_tmdb.account_repository.class">Tmdb\Repository\AccountRepository</parameter>
         <parameter key="wtfz_tmdb.certification_repository.class">Tmdb\Repository\CertificationRepository</parameter>
         <parameter key="wtfz_tmdb.changes_repository.class">Tmdb\Repository\ChangesRepository</parameter>
         <parameter key="wtfz_tmdb.collection_repository.class">Tmdb\Repository\CollectionRepository</parameter>
@@ -37,6 +44,10 @@
     <services>
         <service id="wtfz_tmdb.client" class="%wtfz_tmdb.client.class%">
             <argument type="service" id="wtfz_tmdb.api_token" />
+            <call method="setCaching">
+                <argument>%wtfz_tmdb.cache.enabled%</argument>
+                <argument>%wtfz_tmdb.cache.path%</argument>
+            </call>
         </service>
 
         <service id="wtfz_tmdb.api_token" class="%wtfz_tmdb.api_token.class%">

Twig/WtfzTmdbExtension.php

@@ -4,7 +4,7 @@
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
- * 
+ *
  * @package Wrike
  * @author Michael Roterman <michael@b-found.nl>
  * @copyright (c) 2013, B-Found Internet Marketing & Services
@@ -13,13 +13,13 @@
 
 namespace Wtfz\TmdbBundle\Twig;
 
-
 use Tmdb\Client;
 use Tmdb\Helper\ImageHelper;
 use Tmdb\Model\Image;
 use Tmdb\Repository\ConfigurationRepository;
 
-class WtfzTmdbExtension extends \Twig_Extension {
+class WtfzTmdbExtension extends \Twig_Extension
+{
     private $helper;
 
     private $client;
@@ -60,12 +60,13 @@ public function getName()
     }
 
     /**
-     * @param null $client
+     * @param  null  $client
      * @return $this
      */
     public function setClient($client)
     {
         $this->client = $client;
+
         return $this;
     }
 
@@ -78,12 +79,13 @@ public function getClient()
     }
 
     /**
-     * @param mixed $configuration
+     * @param  mixed $configuration
      * @return $this
      */
     public function setConfiguration($configuration)
     {
         $this->configuration = $configuration;
+
         return $this;
     }
 
@@ -96,12 +98,13 @@ public function getConfiguration()
     }
 
     /**
-     * @param \Wtfz\TmdbBundle\Twig\Tmdb\Helper\ImageHelper $helper
+     * @param  \Wtfz\TmdbBundle\Twig\Tmdb\Helper\ImageHelper $helper
      * @return $this
      */
     public function setHelper($helper)
     {
         $this->helper = $helper;
+
         return $this;
     }
 
@@ -113,5 +116,4 @@ public function getHelper()
         return $this->helper;
     }
 
-
-}
+}

composer.json

@@ -13,7 +13,8 @@
         }
     ],
     "require": {
-        "wtfzdotnet/php-tmdb-api": "*"
+        "wtfzdotnet/php-tmdb-api": "*",
+        "doctrine/cache": ">=1.3.0"
     },
     "autoload": {
         "psr-0": { "Wtfz\\TmdbBundle": "" }