The Bakery Everything CakePHP

Introduction

This is my first community posted code. Criticism welcome, but please be kind.

There isn't much to this Helper, so I will jump right in.

Usage

More than likely you just want to use the thing... Well, its as simple as this:

Including the helper in your application

As with any helper, ensure that it is included in the helpers array in your controller. This will allow you access to it when you need it, in your views.

Controller

Download code class MyController extends AppController {
  public $helpers = array('Gravatar');
  // ...
}

View

Basic Gravatar with default settings:

Download code <?php echo $gravatar->image('someone@cakeisawesome.com'); ?>

Altering the default gravatar:

Download code <?php echo $gravatar->image(
  'someone@cakeisawesome.com',
  array(
    'default' => 'identicon'
  ); ?>

Altering the default gravatar with a custom image:

Download code <?php echo $gravatar->image(
  'someone@cakeisawesome.com',
  array(
    'default' => 'http://mysite.com/defaultavatar.png'
  ); ?>

Changing the gravatar size:

Download code <?php echo $gravatar->image(
  'someone@cakeisawesome.com',
  array(
    'default' => 'identicon',
    'size' => 120
  ); ?>

Adjusting the gravatar ratings to display:

Download code <?php echo $gravatar->image(
  'someone@cakeisawesome.com',
  array(
    'rating' => 'x'
  ); ?>

Including image filename extension on the generated URL:

Download code <?php echo $gravatar->image(
  'someone@cakeisawesome.com',
  array(
    'default' => 'identicon',
    'ext' => true
  ); ?>

Options

The options and their valid values are as follows:

default

• 'identicon' (sample: http://www.gravatar.com/avatar/3b3be63a4c2a439b013787725dfce802?d=identicon)
• 'monsterid' (sample: http://www.gravatar.com/avatar/3b3be63a4c2a439b013787725dfce802?d=monsterid)
• 'identicon' (sample: http://www.gravatar.com/avatar/3b3be63a4c2a439b013787725dfce802?d=wavatar)
• URL to image (example: http://mysite.com/defaultavatar.png)

size

• Minimum value 1
• Maximum value 512

In the event that your Gravatar size is outside these bounds, the helper will adjust it to be size 1 or 512, depending which side of the allowed range your specified value was.

rating

• 'g'
• 'pg'
• 'r'
• 'x'

If rating is either invalid or not specified, Gravatars will automatically be delivered for the 'g' rating. These ratings should be reasonably self explainatory.

ext

• true
• false

If not supplied, an image filename extension will not be included as part of the gravatar generation.

Helper Code

Helper Class:

Download code <?php 
/**
 * A CakePHP View Helper for the display of Gravatar images (http://www.gravatar.com)
 *
 * Copyright 2009, Graham Weldon
 * http://grahamweldon.com
 * Newcastle, Australia
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright Copyright 2008, Graham Weldon
 * @version 1.1
 * @author Graham Weldon <graham@grahamweldon.com>
 * @license http://www.opensource.org/licenses/mit-license.php The MIT License
 */
App::import(array('Security', 'Validation'));

class GravatarHelper extends AppHelper {
        private $__url = 'http://www.gravatar.com/avatar/';
        private $__hashType = 'md5';
        private $__allowedRatings = array('g', 'pg', 'r', 'x');
        private $__defaultIcons = array('identicon', 'monsterid', 'wavatar');
        private $__default = array('default' => 'identicon', 'size' => null, 'rating' => null, 'ext' => false);

        public $helpers = array('Html');

        public function image($email, $options = array()) {
                $options = $this->__cleanOptions(am($this->__default, $options));

                $ext = $options['ext'];
                unset($options['ext']);

                $imageUrl = $this->__url . $this->__emailHash(strtolower($email), $this->__hashType) . ($ext ? '.jpg' : '') . $this->__buildOptions($options);
                unset($options['default'], $options['size'], $options['rating']);

                return $this->Html->image($imageUrl, $options);
        }

        private function __cleanOptions($options) {
                if (!$options['size']) {
                        unset($options['size']);
                } else {
                        if ($options['size'] < 1) {
                                $options['size'] = 1;
                        } elseif ($options['size'] > 512) {
                                $options['size'] = 512;
                        }
                }

                if (!$options['rating'] || !in_array($options['rating'], $this->__allowedRatings)) {
                        unset($options['rating']);
                }

                if (!$options['default']) {
                        unset($options['default']);
                } else {
                        if (!in_array($options['default'], $this->__defaultIcons) && !Validation::url($options['default'])) {
                                unset($options['default']);
                        }
                }

                return $options;
        }

        private function __emailHash($email, $type) {
                return Security::hash($email, $type);
        }

        private function __buildOptions($options) {
                if (count($options)) {
                        $optionArray = array();
                        foreach ($options as $k => $v) {
                                $optionArray[] = $k . '=' . $v;
                        }
                        return '?' . implode('&amp;', $optionArray);
                }
                return '';
        }

}
?>

Final Note

My final note is with regard to the options provided to the helper. Given that the HTML helper already deals extensively with images, it is used to process the actual image tage and return it. Thus, providing any Html Helper image options will ensure they are passed through the gravatar component and onto the Html component, rendering as you would naturally expect from the core Html helper.

Comments and suggestions are encouraged.

If you are using this on your site, let me know!