Public Member Functions | Public Attributes

GravatarHelper Class Reference

Gravatar helper. More...

Inheritance diagram for GravatarHelper:
AppHelper

List of all members.

Public Member Functions

 __construct ($options=array())
 Constructor to override self::$imageOptions.
 getImageOptions ()
 Get self::$imageOptions.
 setImageOptions (array $options=array())
 Set self::$imageOptions.
 imageUrl ($user, array $options=array())
 Starting from user return the url of gravatar image.
 image ($user, array $options=array())
 Return a well formatted.

Public Attributes

 $helpers = array('Html')

Detailed Description

Gravatar helper.

Class to easily handle Gravatar image

Definition at line 27 of file gravatar.php.


Constructor & Destructor Documentation

GravatarHelper::__construct ( options = array()  ) 

Constructor to override self::$imageOptions.

Parameters:
array $options

Definition at line 60 of file gravatar.php.

References setImageOptions().


Member Function Documentation

GravatarHelper::getImageOptions (  ) 

Get self::$imageOptions.

Parameters:
array $options
Returns:
array

Definition at line 71 of file gravatar.php.

GravatarHelper::image ( user,
array $  options = array() 
)

Return a well formatted.

tag using gravatar image. It can be configured with $options that can contain key to override self::imageOptions

  • override of self::$imageOptions
  • 'html' an array of HTML attribute to use in
See also:
self::$imageOptions
Parameters:
string|array $user an email or an array containing 'email' key
array $options image options
Returns:
string

Definition at line 116 of file gravatar.php.

References imageUrl().

GravatarHelper::imageUrl ( user,
array $  options = array() 
)

Starting from user return the url of gravatar image.

Parameters:
string|array $user an email or an array containing 'email' key
array $options override self::$imageOptions
Returns:
string

Definition at line 96 of file gravatar.php.

Referenced by image().

GravatarHelper::setImageOptions ( array $  options = array()  ) 

Set self::$imageOptions.

Parameters:
array $options
Returns:
void

Definition at line 81 of file gravatar.php.

Referenced by __construct().


The documentation for this class was generated from the following file:
Generated on Fri Dec 11 2015 15:29:47 by Doxygen 1.7.1  BEditaBEdita 3.7 Corylus