• Home
  • Horde_Service_Gravatar

PHP Class Horde_Service_Gravatar, horde

See link: http://www.gravatar.com/site/implement/
Author: Gunnar Wrobel ([email protected])
Show file Open project: horde/horde Class Usage Examples

Public Methods

Method Description
__construct ( string $base = self::STANDARD, Horde_Http_Client $client = null ) Constructor.
fetchAvatar ( string $mail, mixed $opts = [] ) : resource Fetch the avatar image.
fetchProfile ( string $mail ) : string Fetch the Gravatar profile information.
getAvatarUrl ( string $mail, mixed $opts = [] ) : Horde_Url Return the Gravatar image URL for the specified mail address. The returned URL can be directly used with an IMG tag e.g.: <img src="http://www.gravatar.com/avatar/hash" />
getId ( string $mail ) : string Return the Gravatar ID for the specified mail address.
getProfile ( string $mail ) : array Return the Gravatar profile information as an array.
getProfileUrl ( string $mail ) : string Return the Gravatar profile URL.

Method Details

__construct() public method

The default Gravatar base URL is Horde_Service_Gravatar::STANDARD. If you need URLs in an HTTPS context you should provide the base URL parameter as Horde_Service_Gravatar::SECURE. In case you wish to access another URL offering the Gravatar API you can specify the base URL of this service as $base.
public __construct ( string $base = self::STANDARD, Horde_Http_Client $client = null )
$base string The base Gravatar URL.
$client Horde_Http_Client The HTTP client to access the server.

fetchAvatar() public method

Fetch the avatar image.
public fetchAvatar ( string $mail, mixed $opts = [] ) : resource
$mail string The mail address.
$opts mixed Additional options. See getAvatarUrl().
return resource The image as stream resource, or null if the server returned an error.

fetchProfile() public method

Fetch the Gravatar profile information.
public fetchProfile ( string $mail ) : string
$mail string The mail address.
return string The profile information.

getAvatarUrl() public method

Return the Gravatar image URL for the specified mail address. The returned URL can be directly used with an IMG tag e.g.: <img src="http://www.gravatar.com/avatar/hash" />
public getAvatarUrl ( string $mail, mixed $opts = [] ) : Horde_Url
$mail string The mail address.
$opts mixed Additional options. If an integer, treated as the 'size' option. If an array, the following options are available: 
  - default: (string) Default behavior. Valid values are '404', 'mm',
             'identicon', 'monsterid', 'wavatar', 'retro', 'blank', or
             a URL-encoded URL to use as the default image.
  - rating: (string) Rating. Valid values are 'g', 'pg', 'r', and 'x'.
  - size: (integer) Image size. Valid values are between 1 and 512.
return Horde_Url The image URL.

getId() public method

Return the Gravatar ID for the specified mail address.
public getId ( string $mail ) : string
$mail string The mail address.
return string The Gravatar ID.

getProfile() public method

Return the Gravatar profile information as an array.
public getProfile ( string $mail ) : array
$mail string The mail address.
return array The profile information.

getProfileUrl() public method

Return the Gravatar profile URL.
public getProfileUrl ( string $mail ) : string
$mail string The mail address.
return string The profile URL.