Zend_View_Helper_Gravatar - Marcin Morawski

Skip to end of metadata

Page restrictions apply
Attachments:2
Added by Marcin Morawski, last edited by Matthew Weier O'Phinney on Oct 11, 2010 (view change)
show comment hide comment

<ac:macro ac:name="unmigrated-inline-wiki-markup"><ac:plain-text-body><![CDATA[

Zend Framework: Zend_View_Helper_Gravatar Component Proposal

Proposed Component Name	Zend_View_Helper_Gravatar
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_View_Helper_Gravatar
Proposers	Marcin Morawski
Zend Liaison	TBD
Revision	1.0 - 1 January 2008: Initial Draft. (wiki revision: 25)

1. Overview
2. References
3. Component Requirements, Constraints, and Acceptance Criteria
4. Dependencies on Other Framework Components
5. Theory of Operation
6. Milestones / Tasks
7. Class Index
8. Use Cases

UC 01
UC 02
UC 03
UC 04
UC 05

9. Class Skeletons

1. Overview

This view helper receives avatars from Gravatar service.

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

This component will return the different closing tag of img dependencies on DOCTYPE of websites.
This component will check whether email adress is valid.
This component will not check whether the default imgage option is valid url or is one of the options available(identicon, monsterid, wavatar or 404)

4. Dependencies on Other Framework Components

Zend_View_Helper_HtmlElement
Zend_View_Exception

5. Theory of Operation

6. Milestones / Tasks

Milestone 1: [DONE] Proposal finished
Milestone 2: [DONE] Proposal accepted
Milestone 3: [DONE] Working implementation
Milestone 4: [DONE] Unit tests
Milestone 5: [DONE] Documentation
Milestone 6: [DONE] Moved to core

7. Class Index

Zend_View_Helper_Gravatar

8. Use Cases

9. Class Skeletons

]]></ac:plain-text-body></ac:macro>

Labels:

None

24 Comments

comments.show.hide

Dec 18, 2009

Shaun Farrell
Marcin, If you need help on this I will be more than glad to help develop this view helper. One suggestion I would have is to default the avatar to 80px. And check to see if the size of the image is between 1 and 512px

Gravatar Doc - "You can specify a "size" or "s" parameter to the URL between 1 and 512 (pixels.) If you omit this step we use a default size of 80 pixels."
- Permalink
1. Dec 20, 2009
 
 Marcin Morawski
 Thanks for the suggestion. 
 I changed this. Now default size of image is 80. I also add a validator, so you must set a value between 1 and 512. 
 This class is finished. You can download it. 
 I added this class as attachment to this wiki page. 
 
 If you want help me you can help me with write documentation and unit test. Of course you can also check this class, but i think, that this class is completed and work nicely<ac:emoticon ac:name="cheeky" />.
 Permalink
Jan 30, 2010

Benjamin Steininger
Would be nice if it supports ssl via api-url: <a class="external-link" href="https://secure.gravatar.com/">https://secure.gravatar.com/</a>

Mentioned here: <a class="external-link" href="http://blog.gravatar.com/#post-150">http://blog.gravatar.com/#post-150</a>

And what about the rating-parameter ? 
- Permalink
1. Jan 31, 2010
 
 Marcin Morawski
 Done
 Permalink
May 12, 2010

Colin Guthrie
Awesome <ac:emoticon ac:name="smile" /> I was just about to write a similar class and figured I'd check first. Glad I did <ac:emoticon ac:name="smile" />

Would be nice to get this added to the main distribution.
- Permalink
Jul 21, 2010

Dolf Schimmel (Freeaqingme)
Why do you want to not use SSL by default?
- Permalink
1. Jul 22, 2010
 
 Marc Bennewitz (private)
 Using the secure url should be part of the options and if not specified it should be auto selected.
 
 <ul>
 <li>add option secure 
 Default to:
 <ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
 if (isset($options['secure'])) {
 $options['secure'] = (bool)$options['secure'];
 } else {
 $options['secure'] = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS']);
 }
 ]]></ac:plain-text-body></ac:macro></li>
 </ul>
 Permalink
 1. Jul 31, 2010
 
 Marcin Morawski
 implemented
 
 Permalink
 1. Aug 18, 2010
 
 Marc Bennewitz (private)
 
 Today I looked your code on incubator and I have 2 small explanatory notes:
 
 1. options must be underscored 
 2. the secure option need 3 different values true, false and null for autodetect 
 else getSecure returns the wrong value
 
 <ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
 // ...
 
 protected $_options = array(
 'img_size' => 80,
 'default_img' => self::DEFAULT_MM,
 'rating' => self::RATING_G,
 'secure' => null // auto detect
 );
 
 // ...
 
 public function gravatar( $email = null, $options = array(), $attribs = array() )
 {
 if ($email === null)
 
 Unknown macro: { return $this; }
 
 $this->setEmail($email);
 $this->setAttribs($attribs);
 
 foreach ($options as $k => $v) {
 $m = 'set' . str_replace(' ', '', ucwords(str_replace('_', ' ', $k)));
 if (!method_exists($this, $m))
 
 Unknown macro: { // nothing or exception or return empty string ? }
 
 $this->{$m}($value);
 }
 
 return $this->getImgTag();
 }
 
 // ...
 
 public function setSecure($flag)
 
 Unknown macro: { $this->_options['secure'] = ($flag === null) ? null }
 
 public function getSecure()
 {
 if ($this->_options['secure'] === null)
 
 Unknown macro: { return isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off'; }
 
 else
 
 Unknown macro: { return $this->_options['secure']; }
 
 }
 
 // ....
 
 ]]></ac:plain-text-body></ac:macro>
 
 Permalink
 1. Aug 18, 2010
 
 Marc Bennewitz (private)
 
 Oh - additionally the main gravator method should return $this ever 
 and the class should implement the magic method __toString().
 
 Than the following also works:
 <ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
 echo $this->gravatar('my@mail.com')->setSecure(true);
 ]]></ac:plain-text-body></ac:macro>
 
 Permalink
 
 Aug 19, 2010
 
 Marcin Morawski
 
 I'll do it and: 
 I remove third parameter(attribs for image). And move it to second parameter(atttribs key). 
 Then I can use setOptions method to set all options for this class.
 
 Permalink
 
 Aug 19, 2010
 
 Marc Bennewitz (private)
 
 html attributes should be still separated from gravatar options. 
 -> Some JS-Libs define special html attributes and this could overlap with gravatar options.
 
 Permalink
 
 Aug 22, 2010
 
 Marcin Morawski
 
 I was thinking about something like this: 
 $this->gravatar()->setOptions( 
 array( 
 'img_size' => 80, 
 'default_img' => Zend_View_Helper_Gravatar::DEFAULT_WAVATAR, 
 ........ 
 'attribs' => array('class' => 'gravatar', 'title' => 'title value') 
 )); 
 Then html attributes are seperated.
 
 I now that html attributes have other function than options for gravatar. Pass it to one parameter may be confusing(even with key attribs). 
 
 Permalink
 
 Aug 22, 2010
 
 Marc Bennewitz (private)
 
 Than your gravatar view helper would be the only view helper (extending HtmlElement) where the attrib parameter must be an option. 
 -> It should be similar to other view helper based on html element.
 
 Permalink
2. Jul 22, 2010
 
 Colin Guthrie
 For most uses, this is not needed and add unnecessary overhead at the client side. It also means that round-robin DNS names (e.g. using 0.gravatar.com, 1.gravatar.com etc.) is not possible. Using different host names is something Google recommends as part of it's "Page Speed" metrics. There is obviously a practical limit, but 2 or 3 different domains for loading e.g. 10-20 Gravatars each would seem sensible. Sadly there is only one SSL URL so this technique cannot be used on SSL. 
 
 So that is one reason why it may not be nice to be on by default., but that is not to say that it cannot be auto-detected: e.g. if the request is a secure one, then use secure with Gravatar as Marc suggests above.
 Permalink
 1. Aug 18, 2010
 
 Marc Bennewitz (private)
 Browsers displays a warning if a ssl page loads insecure content (like the gravatar image)
 
 Permalink
 1. Aug 18, 2010
 
 Colin Guthrie
 
 Yes I know, that's why I said it should be autodetected rather than on by default. I was trying to point out all the reasons why using SSL by default (even if the request is non-ssl) would be a bad idea. I fully appreciate the need to use SSL on an SSL request.
 
 Permalink
Aug 01, 2010

Georgy Turevich
Why do you use validation in "view" helper? Typically, validation is used in the model-layer.

I think, it must be removed or must be optional and disabled by default
- Permalink
1. Aug 02, 2010
 
 Marcin Morawski
 Yes, you are right. 
 I fix it.
 Permalink
Aug 03, 2010

Dolf Schimmel (Freeaqingme)
<ac:macro ac:name="note"><ac:rich-text-body>Community Review Team Recommendation

The CR Team advises accepting this proposal as-is.</ac:rich-text-body></ac:macro>
- Permalink
Aug 10, 2010

Shahar Evron
Hi,

This looks very good. I needed something just like this and didn't know about your proposal, so I suggested this: <a class="external-link" href="http://framework.zend.com/svn/framework/laboratory/Zend_View_Helper_Gravatar/library/Zend/View/Helper/Gravatar.php">http://framework.zend.com/svn/framework/laboratory/Zend_View_Helper_Gravatar/library/Zend/View/Helper/Gravatar.php</a> - I will drop my implementation since it looks like you already did the thinking and got reviewed, but maybe you can take a look at my implementation and borrow something <ac:emoticon ac:name="smile" />

BTW I don't think it's the view helper's job to validate the email address. My assumption is that an email address being used from a gravater was already validated in the past by the app - e.g. if used for user comments, you probably validate the user's email when accepting the comment in the form or before saving to the DB. 

In any case an invalid email address will result in falling back to the default image, and not in some security problem. So I think validating here would be waste of CPU cycles. 

Shahar.
- Permalink
1. Aug 11, 2010
 
 Marcin Morawski
 Thanks for sharing. 
 I borrowed some ideas.
 
 I also don't check email address and image size. 
 You check image size, but i think that this value also should be set from model/configuration file.
 
 Moreover, if you pass invalid value, this not destroy your application. You get only very small or very big avatar(1px or 512px)
 Permalink
Aug 24, 2010

Marcin Morawski
Last Changes:
<ul>
<li>added __toString method</li>
<li>added setOptions method</li>
<li>restored third parameter(html attributes)</li>
<li>now gravatar method returns object</li>
<li>fixed set/getSecure</li>
<li>changed name of keys options</li>
<li>modified Wiki page</li>
</ul>
- Permalink
Sep 19, 2010

Adam Dyson
I am in the process of building a blog extension for the Magento platform and I just happened to stumble across this page. Thanks for all your efforts, it came in very handy! I've made some minor adjustments to suit my needs, maybe they'll be of some help.

<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[

class Ontic_Blog_Helper_Gravatar extends Ontic_Core_Helper_Abstract
{
/**
- The gravatar service url.
- @since 1.0.0
- @var string
- @access public
 */
 const GRAVATAR_URL = 'http://www.gravatar.com/avatar';
/**
- The secure gravatar service url.
- @since 1.0.0
- @var string
- @access public
 */
 const GRAVATAR_URL_SECURE = 'https://secure.gravatar.com/avatar';
/**
- Rating suitable for all websites and any audience type.
- @since 1.0.0
- @var string
- @access public
 */
 const RATING_G = 'g';
/**
- Rating suitable for mature audiences.
- @since 1.0.0
- @var string
- @access public
 */
 const RATING_PG = 'pg';
/**
- Rating suitable for adults.
- @since 1.0.0
- @var string
- @access public
 */
 const RATING_R = 'r';
/**
- Rating suitable for deviant weirdos.
- @since 1.0.0
- @var string
- @access public
 */
 const RATING_X = 'x';
/**
- Do not display an image if no email was associated.
- @since 1.0.0
- @var string
- @access public
 */
 const DEFAULT_404 = '404';
/**
- Display a cartoon-style silhouetted outline of a person.
- @since 1.0.0
- @var string
- @access public
 */
 const DEFAULT_MM = 'mm';
/**
- Display an ugly looking geometric pattern based on an email hash.
- @since 1.0.0
- @var string
- @access public
 */
 const DEFAULT_IDENTICON = 'identicon';
/**
- Display an ugly looking generated monster with different colors and faces.
- @since 1.0.0
- @var string
- @access public
 */
 const DEFAULT_MONSTERID = 'monsterid';
/**
- Display an ugly looking generated face with differing features and backgrounds.
- @since 1.0.0
- @var string
- @access public
 */
 const DEFAULT_WAVATAR = 'wavatar';
/**
- Stores the gravatar profile email address.
- @since 1.0.0
- @var string
- @access protected
 */
 protected $_email;
/**
- Stores whether a secure url is used to call the gravatar service.
- @since 1.0.0
- @var boolean
- @access protected
 */
 protected $_secure;
/**
- Stores the gravatar request options with pre-defined settings.
- @since 1.0.0
- @var string
- @access protected
 */
 protected $_options = array(
 'size' => 80,
 'default' => self::DEFAULT_MM,
 'rating' => self::RATING_G
 );
/**
- Stores the gravatar image html attributes.
- @since 1.0.0
- @var array
- @access protected
 */
 protected $_attributes;
/**
- Return an avatar using the gravatar service.
- @since 1.0.0
- @param string $email
- @param array $options
- @param array $attributes
- @return Ontic_Blog_Helper_Gravatar
- @access public
 */
 public function gravatar($email = '', $options = array(), $attributes = array())
 Unknown macro: { $this->setEmail($email); $this->setOptions($options); $this->setAttributes($attribs); return $this; }
/**
- Return the gravatar profile email address.
- @since 1.0.0
- @return string
- @access public
 */
 public function getEmail()
 Unknown macro: { return $this->_email; }
/**
- Set the gravatar profile email address.
- @since 1.0.0
- @param string $email
- @return Ontic_Blog_Helper_Gravatar
- @access public
 */
 public function setEmail($email)
 Unknown macro: { $this->_email = $email; return $this; }
/**
- Return the gravatar image size.
- @since 1.0.0
- @return integer
- @access public
 */
 public function getSize()
 Unknown macro: { return $this->_options['size']; }
/**
- Set the gravatar image size.
- @since 1.0.0
- @param integer $size
- @return Ontic_Blog_Helper_Gravatar
- @access public
 */
 public function setSize($size)
 {
 if (is_numeric($size) && $size >= 1 && $size <= 512)
 Unknown macro: { $this->_options['size'] = (integer) $size; }
return $this;
}

/**
- Return the default gravatar image.
- @since 1.0.0
- @return integer
- @access public
 */
 public function getDefault()
 Unknown macro: { return $this->_options['default']; }
/**
- Set the default gravatar image.
- @since 1.0.0
- @param string $image
- @return Ontic_Blog_Helper_Gravatar
- @access public
 */
 public function setDefault($image)
 {
 if (preg_match('/^(https?:\/\/[\w\-]\.[\w\-]+)/i', $image))
 Unknown macro: { $this->_options['default'] = urlencode($image); }
 
 else if (in_array($image, array(self::DEFAULT_404, self::DEFAULT_MM, self::DEFAULT_IDENTICON, self::DEFAULT_MONSTERID, self::DEFAULT_WAVATAR)))
 
 Unknown macro: { $this->_options['default'] = $image; }
return $this;
}

/**
- Return the gravatar rating.
- @since 1.0.0
- @return string
- @access public
 */
 public function getRating()
 Unknown macro: { return $this->_options['rating']; }
/**
- Set the gravatar rating.
- @since 1.0.0
- @param string $rating
- @return Ontic_Blog_Helper_Gravatar
- @access public
 */
 public function setRating($rating)
 {
 if (in_array($rating, array(self::RATING_G, self::RATING_PG, self::RATING_R, self::RATING_X)))
 Unknown macro: { $this->_options['rating'] = $rating; }
return $this;
}

/**
- Return whether a secure url is used to call the gravatar service.
- @since 1.0.0
- @return boolean
- @access public
 */
 public function getSecure()
 {
 if ($this->_secure === null)
 Unknown macro: { return isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off'; }
return $this->_secure;
}

/**
- Set whether a secure url is used to call the gravatar service.
- @since 1.0.0
- @param boolean $flag
- @return Ontic_Blog_Helper_Gravatar
- @access public
 */
 public function setSecure($flag)
 {
 if ($flag === null)
 Unknown macro: { $this->_secure = $flag; }
 
 else
 
 Unknown macro: { $this->_secure = (boolean) $flag; }
return $this;
}

/**
- Set the gravatar options.
- @since 1.0.0
- @param array $options
- @return Ontic_Blog_Helper_Gravatar
- @access public
 */
 public function setOptions(array $options)
 {
 foreach ($options as $key => $value)
 {
 $method = 'set'.uc_words($key, '');
if (method_exists($this, $method))
{
$this->{$method}($value);
}
}

return $this;
}

/**
- Return the gravatar image html attributes.
- @since 1.0.0
- @return array
- @access public
 */
 public function getAttributes()
 Unknown macro: { return $this->_attributes; }
/**
- Set the gravatar image html attributes.
- @since 1.0.0
- @param array $attributes
- @return Ontic_Blog_Helper_Gravatar
- @access public
 */
 public function setAttributes(array $attributes)
 Unknown macro: { $this->_attributes = $attributes; return $this; }
/**
- Return the gravatar image tag.
- @since 1.0.0
- @return string
- @access public
 */
 public function toHtml()
 Unknown macro: { $this->_attributes['src'] = $this->_getAvatarUrl(); $this->_attributes['width'] = $this->getSize(); $this->_attributes['height'] = $this->getSize(); return '<img '.$this->serialize($this->_attributes).' />'; }
/**
- Return the gravatar service url.
- @since 1.0.0
- @return string
- @access protected
 */
 protected function _getGravatarUrl()
 {
 if ($this->_secure === false)
 Unknown macro: { return self}
return self::GRAVATAR_URL_SECURE;
}

/**
- Return the avatar url including options.
- @since 1.0.0
- @return string
- @access protected
 */
 protected function _getAvatarUrl()
 Unknown macro: { return $this->_getGravatarUrl().'/'.md5($this->_email).'?'.http_build_query($this->_options); }
 
 }
]]></ac:plain-text-body></ac:macro>
- Permalink

Zend Framework: Zend_View_Helper_Gravatar Component Proposal

Table of Contents

1. Overview

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

4. Dependencies on Other Framework Components

5. Theory of Operation

6. Milestones / Tasks

7. Class Index

8. Use Cases

UC 01

UC 02

UC 03

UC 04

UC 05

9. Class Skeletons