Added PHPDoc to GravatarHelper. GravatarApi is know injected into the…

… GravatarHelper. Created a service for GravatarApi to make it configurable. Removed static from GravatarApi::getUrl so the class can be configured when intialized
henrikbjorn · Aug 17, 2010 · 4c2c0e8 · 4c2c0e8
1 parent 0c9b720
commit 4c2c0e8
Show file tree

Hide file tree

Showing 5 changed files with 81 additions and 22 deletions.
diff --git a/GravatarApi.php b/GravatarApi.php
@@ -14,23 +14,43 @@
  */
 class GravatarApi
 {
+    /**
+     * @var array $default array of default options that can be overriden with getters and in the construct.
+     */
+    protected $defaults = array(
+        'size' => 80,
+        'rating' => 'g',
+        'default' => null,
+    );
+
+    /**
+     * Constructor
+     *
+     * @param array $options the array is merged with the defaults.
+     * @return void
+     */
+    public function __construct(array $options = array()) {
+        $this->defaults = array_merge($this->defaults, $options);
+    }
+
     /**
      * Returns a url for a gravatar.
      *
      * @param  string  $email
-     * @param  integer $size    defaults to 80
-     * @param  string  $rating  defaults to g
-     * @param  string  $default defaults to null
+     * @param  integer $size
+     * @param  string  $ratin
+     * @param  string  $default
      * @return string
      */
-    public static function getUrl($email, $size = 80, $rating = 'g', $default = null)
+    public function getUrl($email, $size = null, $rating = null, $default = null)
     {
         $hash = md5(strtolower($email));
 
+        $options = array_merge($this->defaults, array_filter(compact('size', 'rating', 'default')));
         $map = array(
-            's' => $size,
-            'r' => $rating,
-            'd' => $default,
+            's' => $options['size'],
+            'r' => $options['rating'],
+            'd' => $options['default'],
         );
 
         return 'http://www.gravatar.com/avatar/' . $hash . '?' . http_build_query(array_filter($map));

diff --git a/Resources/config/helper.xml b/Resources/config/helper.xml
@@ -4,13 +4,17 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://www.symfony-project.org/schema/dic/services http://www.symfony-project.org/schema/dic/services/services-1.0.xsd">
 
-  <parameters>
-    <parameter key="templating.helper.gravatar.class">Bundle\GravatarBundle\Templating\Helper\GravatarHelper</parameter>
-  </parameters>
+    <parameters>
+        <parameter key="templating.helper.gravatar.class">Bundle\GravatarBundle\Templating\Helper\GravatarHelper</parameter>
+        <parameter key="gravatar.api.class">Bundle\GravatarBundle\GravatarApi</parameter>
+    </parameters>
 
-  <services>
-    <service id="templating.helper.gravatar" class="%templating.helper.gravatar.class%">
-      <tag name="templating.helper" alias="gravatar" />
-    </service>
-  </services>
+    <services>
+        <service id="gravatar.api" class="%gravatar.api.class%" />
+
+        <service id="templating.helper.gravatar" class="%templating.helper.gravatar.class%">
+            <tag name="templating.helper" alias="gravatar" />
+            <argument type="service" id="gravatar.api" />
+        </service>
+    </services>
 </container>
diff --git a/Templating/Helper/GravatarHelper.php b/Templating/Helper/GravatarHelper.php
@@ -7,15 +7,39 @@
 
 class GravatarHelper implements HelperInterface
 {
+    /**
+     * @var string $charset
+     */
     protected $charset = 'UTF-8';
 
-    public function __construct()
+    /**
+     * @var Bundle\GravatarBundle\GravatarApi $api
+     */
+    protected $api;
+
+    /**
+     * Constructor
+     *
+     * @param Bundle\GravatarBundle\GravatarApi $api
+     * @return void
+     */
+    public function __construct(GravatarApi $api)
     {
+        $this->api = $api;
     }
 
-    public function render($email, $size = 80, $rating = 'g', $default = null)
+    /**
+     * Returns a url for a gravatar
+     *
+     * @param  string  $email
+     * @param  integer $size
+     * @param  string  $rating
+     * @param  string  $default
+     * @return string
+     */
+    public function render($email, $size = null, $rating = null, $default = null)
     {
-        return GravatarApi::getUrl($email, $size, $rating, $default);
+        return $this->api->getUrl($email, $size, $rating, $default);
     }
 
     /**

diff --git a/Tests/GravatarApiTest.php b/Tests/GravatarApiTest.php
@@ -7,15 +7,26 @@
 
 class GravatarApiTest extends TestCase
 {
-
     public function testGravatarUrlWithDefaultOptions()
     {
-        $this->assertEquals('http://www.gravatar.com/avatar/0aa61df8e35327ac3b3bc666525e0bee?s=80&r=g', GravatarApi::getUrl('henrik@bearwoods.dk'));
+        $api = new GravatarApi();
+        $this->assertEquals('http://www.gravatar.com/avatar/0aa61df8e35327ac3b3bc666525e0bee?s=80&r=g', $api->getUrl('henrik@bearwoods.dk'));
     }
 
     public function testGravatarUrlWithDefaultImage()
     {
-        $this->assertEquals('http://www.gravatar.com/avatar/0aa61df8e35327ac3b3bc666525e0bee?s=80&r=g&d=mm', GravatarApi::getUrl('henrik@bearwoods.dk', 80, 'g', 'mm'));
+        $api = new GravatarApi();
+        $this->assertEquals('http://www.gravatar.com/avatar/0aa61df8e35327ac3b3bc666525e0bee?s=80&r=g&d=mm', $api->getUrl('henrik@bearwoods.dk', 80, 'g', 'mm'));
+    }
+
+    public function testGravatarInitializedWithOptions()
+    {
+        $api = new GravatarApi(array(
+            'size' => 20,
+            'default' => 'mm',
+        ));
+
+        $this->assertEquals('http://www.gravatar.com/avatar/0aa61df8e35327ac3b3bc666525e0bee?s=20&r=g&d=mm', $api->getUrl('henrik@bearwoods.dk'));
     }
 
 }
diff --git a/Tests/Templating/Helper/GravatarHelperTest.php b/Tests/Templating/Helper/GravatarHelperTest.php
@@ -12,7 +12,7 @@ class GravatarHelperTest extends TestCase
 
     public function setUp()
     {
-        $this->helper = new GravatarHelper();
+        $this->helper = new GravatarHelper(new GravatarApi());
     }
 
     public function testRenderReturnsTheCorrectUrl()