GravatarsProvider Class Reference

Inheritance diagram for GravatarsProvider:

Public Member Functions
	getAvatarEditUrl ($response,\XoopsUser $userinfo)
	getAvatarUrl ($response, $userinfo)
	getDescription ()
	getName ()
Public Member Functions inherited from Xoops\Core\Service\AbstractContract
	getDescription ()
	getMode ()
	getName ()
	getPriority ()
	setPriority ($priority)

Private Member Functions
	getUserById ($uid)

Static Private Member Functions
static	getGravatar ($email)

Additional Inherited Members
Public Attributes inherited from Xoops\Core\Service\Contract\AvatarInterface
const	MODE = \Xoops\Core\Service\Manager::MODE_EXCLUSIVE
Protected Attributes inherited from Xoops\Core\Service\AbstractContract
	$priority = Manager::PRIORITY_MEDIUM

Detailed Description

Definition at line 26 of file GravatarsProvider.php.

Member Function Documentation

GravatarsProvider::getAvatarEditUrl	(		$response,
		\XoopsUser	$userinfo
	)

getAvatarEditUrl - given user info return absolute URL to edit avatar data

Parameters

Response	$response	object
\XoopsUser	$userinfo	XoopsUser object for user

Returns

void - response->value set to absolute URL to editing function for avatar data

Implements Xoops\Core\Service\Contract\AvatarInterface.

Definition at line 143 of file GravatarsProvider.php.

References $email, $link, $response, and Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

GravatarsProvider::getAvatarUrl	(		$response,
			$userinfo
	)

getAvatarUrl - given user info return absolute URL to avatar image

Parameters

Response	$response	object
mixed	$userinfo	XoopsUser object for user or array user info, 'uid', 'uname' and 'email' required int user uid

Returns

void - response->value set to absolute URL to avatar image

Implements Xoops\Core\Service\Contract\AvatarInterface.

Definition at line 108 of file GravatarsProvider.php.

References $email, $response, $user, and getUserById().

Here is the call graph for this function:

GravatarsProvider::getDescription

(

)

getDescription - get human readable description of the service provider

Returns

string

Definition at line 93 of file GravatarsProvider.php.

static GravatarsProvider::getGravatar (   $email )

staticprivate

Get a Gravatar URL for a specified email address.

Parameters

string

$email

The email address

Returns

String containing either just a URL or a complete image tag

http://gravatar.com/site/implement/images/php/

Definition at line 37 of file GravatarsProvider.php.

References $email, $helper, and $url.

GravatarsProvider::getName

(

)

getName - get a short name for this service provider. This should be unique within the scope of the named service, so using module dirname is suggested.

Returns

string - a unique name for the service provider

Definition at line 83 of file GravatarsProvider.php.

GravatarsProvider::getUserById (   $uid )

private

getUserById - get a user object from a user id

Parameters

int

$uid

a user id

Returns

object|null

Definition at line 71 of file GravatarsProvider.php.

References $uid, $user, and Xoops\getInstance().

Referenced by getAvatarUrl().

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• C:/usr64/htdocs/modules/gravatars/class/GravatarsProvider.php