Docs For Class Services

[line 75]
PHP support for the Libravatar.org service.

Using this class is easy. After including or requiring Services/Libravatar.php simply do:

 $libravatar = new Services_Libravatar();

 $url = $libravatar->getUrl('melissa@meldraweb.com');

This would populate $url with the string:

 http://cdn.libravatar.org/avatar/4db84629c121f2d443d33bdb9fd149bc

A complicated lookup using all the options is:

 $libravatar = new Services_Libravatar();

 $libravatar->setSize(40);
 $libravatar->setAlgorithm('sha256');
 $libravatar->setHttps(true);
 $libravatar->setDefault(
     'http://upload.wikimedia.org/wikipedia/commons/a/af/Tux.png'
 );
 $url = $libravatar->getUrl('melissa@meldraweb.com');

Author: Melissa Draper <melissa@meldraweb.com>
Version: Release: 0.2.2
Copyright: 2011 Services_Libravatar committers.
Link: http://pear.php.net/package/Services_Libravatar
Since: Class available since Release 0.1.0
License: MIT License

checkOptionsArray [line 223]

void checkOptionsArray(
array
$options)

Checks the options array and verify that only allowed options are in it.

Throws: Exception When an invalid option is used
Access: protected

Parameters:

array $options — Array of options for getUrl()

[ Top ]

comparePriority [line 486]

mixed comparePriority(
mixed
$a, mixed
$b)

Sorting function for record priorities.

Return: The result of the comparison
Since: Method available since Release 0.1.0
Access: protected

Parameters:

mixed	`$a`	—	A mixed value passed by usort()
mixed	`$b`	—	A mixed value passed by usort()

[ Top ]

detectHttps [line 500]

self detectHttps(
)

Automatically set the https option depending on the current connection value.

If the current connection is HTTPS, the https options is activated. If it is not HTTPS, the https option is deactivated.

Access: public

[ Top ]

domainGet [line 361]

string domainGet(
string
$identifier)

Grab the domain from the identifier.

Extract the domain from the Email or OpenID.

Return: A string of the domain to use
Since: Method available since Release 0.1.0
Access: protected

Parameters:

string $identifier — A string of the email address or openid URL

[ Top ]

getUrl [line 153]

string getUrl(
string
$identifier, [array
$options = array()])

Composes a URL for the identifier and options passed in

Compose a full URL as specified by the Libravatar API, based on the email address or openid URL passed in, and the options specified.

Return: A string of a full URL for an avatar image
Since: Method available since Release 0.2.0
Throws: InvalidArgumentException When an invalid option is passed
Access: public

Parameters:

string	`$identifier`	—	a string of either an email address or an openid url
array	`$options`	—	an array of (bool) https, (string) algorithm (string) size, (string) default. See the set* methods.

[ Top ]

identifierHash [line 284]

string identifierHash(
string
$identifier, [string
$hash = 'md5'])

Create a hash of the identifier.

Create a hash of the email address or openid passed in. Algorithm used for email address ONLY can be varied. Either md5 or sha256 are supported by the Libravatar API. Will be ignored for openid.

Return: A string hash of the identifier.
Since: Method available since Release 0.1.0
Access: protected

Parameters:

string	`$identifier`	—	A string of the email address or openid URL
string	`$hash`	—	A string of the hash algorithm type to make Uses the php implementation of hash() MD5 preferred for Gravatar fallback

[ Top ]

normalizeIdentifier [line 259]

string normalizeIdentifier(
string
$identifier)

Normalizes the identifier (E-mail address or OpenID)

Return: Normalized identifier
Access: protected

Parameters:

string $identifier — E-Mail address or OpenID

[ Top ]

normalizeOpenId [line 306]

string normalizeOpenId(
mixed
$identifier)

Normalizes an identifier (URI or XRI)

Return: Normalized Identifier. Empty string when the OpenID is invalid.
Access: public

Parameters:

mixed $identifier — URI or XRI to be normalized

[ Top ]

processAlgorithm [line 518]

string processAlgorithm(
string
$algorithm)

Verify and cast the email address hashing algorithm to use.

Return: Algorithm
Throws: InvalidArgumentException When an unsupported algorithm is given
Access: protected

Parameters:

string $algorithm — Algorithm to use, "sha256" or "md5".

[ Top ]

processDefault [line 546]

string processDefault(
string
$url)

Verify and cast the default URL to use when no avatar image can be found.

If none is set, the libravatar logo is returned.

Return: Default URL
Throws: InvalidArgumentException When an invalid URL is given
Access: protected

Parameters:

string

$url

—

Full URL to use OR one of the following:

"404" - give a "404 File not found" instead of an image
"mm"
"identicon"
"monsterid"
"wavatar"
"retro"

[ Top ]

processSize [line 583]

integer processSize(
integer
$size)

Verify and cast the required size of the images.

Return: Size
Throws: InvalidArgumentException When a size <= 0 is given
Access: protected

Parameters:

integer $size — Size (width and height in pixels) of the image. NULL for the default width.

[ Top ]

setAlgorithm [line 607]

self setAlgorithm(
string
$algorithm)

Set the email address hashing algorithm to use.

To keep gravatar compatibility, use "md5".

Throws: InvalidArgumentException When an unsupported algorithm is given
Access: public

Parameters:

string $algorithm — Algorithm to use, "sha256" or "md5".

[ Top ]

setDefault [line 629]

self setDefault(
string
$url)

Set the default URL to use when no avatar image can be found.

If none is set, the gravatar logo is returned.

Throws: InvalidArgumentException When an invalid URL is given
Access: public

Parameters:

string

$url

—

Full URL to use OR one of the following:

"404" - give a "404 File not found" instead of an image
"mm"
"identicon"
"monsterid"
"wavatar"
"retro"

[ Top ]

setHttps [line 645]

self setHttps(
boolean
$useHttps)

Set if HTTPS URLs shall be returned.

See: Services_Libravatar::detectHttps()
Access: public

Parameters:

boolean $useHttps — If HTTPS url shall be returned

[ Top ]

setSize [line 661]

self setSize(
integer
$size)

Set the required size of the images.

Every avatar image is square sized, which means you need to set only number.

Throws: InvalidArgumentException When a size <= 0 is given
Access: public

Parameters:

integer $size — Size (width and height) of the image

[ Top ]

srvGet [line 407]

string srvGet(
string
$domain, [boolean
$https = false])

Get the target to use.

Get the SRV record, filtered by priority and weight. If our domain has no SRV records, fall back to Libravatar.org

Return: The target URL.
Since: Method available since Release 0.1.0
Access: protected

Parameters:

string	`$domain`	—	A string of the domain we extracted from the provided identifier with domainGet()
boolean	`$https`	—	Whether or not to look for https records

[ Top ]

url [line 131]

string url(
string
$identifier, [array
$options = array()])

Composes a URL for the identifier and options passed in

Compose a full URL as specified by the Libravatar API, based on the email address or openid URL passed in, and the options specified.

Return: A string of a full URL for an avatar image
Deprecated: Use getUrl() instead
Since: Method available since Release 0.2.0
Access: public

Parameters:

string	`$identifier`	—	a string of either an email address or an openid url
array	`$options`	—	an array of (bool) https, (string) algorithm (string) size, (string) default. See the set* methods.

[ Top ]

Class: Services_Libravatar

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$algorithm = 'md5'

$default =

$https =

$size =

Method Detail

checkOptionsArray [line 223]

Parameters:

comparePriority [line 486]

Parameters:

detectHttps [line 500]

domainGet [line 361]

Parameters:

getUrl [line 153]

Parameters:

identifierHash [line 284]

Parameters:

normalizeIdentifier [line 259]

Parameters:

normalizeOpenId [line 306]

Parameters:

processAlgorithm [line 518]

Parameters:

processDefault [line 546]

Parameters:

processSize [line 583]

Parameters:

setAlgorithm [line 607]

Parameters:

setDefault [line 629]

Parameters:

setHttps [line 645]

Parameters:

setSize [line 661]

Parameters:

srvGet [line 407]

Parameters:

url [line 131]

Parameters: