View/Helper/Gravatar.php

Show:

inherited

Classes
- \Zend_View_Helper_Gravatar

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_View
Subpackage: Helper
Version: $Id: Doctype.php 16971 2009-07-22 18:05:45Z mikaelkael $

\Zend_View_Helper_Gravatar
jump to top

Package: Zend\View\Helper

Helper for retrieving avatars from gravatar.com

Parent(s): \Zend_View_Helper_HtmlElement < \Zend_View_Helper_Abstract
Copyright: Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Link: http://pl.gravatar.com/site/implement/url

Constants

 
                GRAVATAR_URL
                = 'http://www.gravatar.com/avatar'

URL to gravatar service

 
                GRAVATAR_URL_SECURE
                = 'https://secure.gravatar.com/avatar'

Secure URL to gravatar service

 
                RATING_G
                = 'g'

Gravatar rating

 
                RATING_PG
                = 'pg'

 
                RATING_R
                = 'r'

 
                RATING_X
                = 'x'

 
                DEFAULT_404
                = '404'

Default gravatar image value constants

 
                DEFAULT_MM
                = 'mm'

 
                DEFAULT_IDENTICON
                = 'identicon'

 
                DEFAULT_MONSTERID
                = 'monsterid'

 
                DEFAULT_WAVATAR
                = 'wavatar'

 
                EOL
                = "\n"

inherited

EOL character

Inherited from: \Zend_View_Helper_HtmlElement::EOL

Inherited_from: \Zend_View_Helper_HtmlElement::EOL

Properties

array $_attribs

Attributes for HTML image tag

Details

Type: array

string $_closingBracket = null

inherited

The tag closing bracket

Inherited from: \Zend_View_Helper_HtmlElement::$$_closingBracket

Default valuenullDetails

Type: string
Inherited_from: \Zend_View_Helper_HtmlElement::$$_closingBracket

string $_email

Email Adress

Details

Type: string

array $_options = array('img_size' => 80, 'default_img' => self::DEFAULT_MM, 'rating' => self::RATING_G, 'secure' => null)

Options

Default valuearray('img_size' => 80, 'default_img' => self::DEFAULT_MM, 'rating' => self::RATING_G, 'secure' => null)Details

Type: array

\Zend_View_Interface $view = null

inherited

View object

Inherited from: \Zend_View_Helper_Abstract::$$view \Zend_View_Helper_HtmlElement::$$view

Default valuenullDetails

Type: \Zend_View_Interface
Inherited_from: \Zend_View_Helper_Abstract::$$view
Inherited_from: \Zend_View_Helper_HtmlElement::$$view

Methods

__toString() : string

Return valid image tag

Returns

Type	Description
string

_getAvatarUrl() : string

Get avatar url (including size, rating and default image oprions)

Returns

Type	Description
string

_getGravatarUrl() : string

Get URL to gravatar's service.

Returns

Type	Description
string	URL

_htmlAttribs(array $attribs) : string

inherited

Converts an associative array to a string of tag attributes.

Inherited from: \Zend_View_Helper_HtmlElement::_htmlAttribs()

Parameters

Name	Type	Description
$attribs	array	From this array, each key-value pair is converted to an attribute name and value.

Returns

Type	Description
string	The XHTML for the attributes.

Details

Access: public

_isStrictDoctype() : boolean

inherited

Is doctype strict?

Inherited from: \Zend_View_Helper_HtmlElement::_isStrictDoctype()

Returns

Type	Description
boolean

_isXhtml() : boolean

inherited

Is doctype XHTML?

Inherited from: \Zend_View_Helper_HtmlElement::_isXhtml()

Returns

Type	Description
boolean

_normalizeId(string $value) : string

inherited

Normalize an ID

Inherited from: \Zend_View_Helper_HtmlElement::_normalizeId()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
string

_setSrcAttribForImg() : void

Set src attrib for image.

You shouldn't set a own url value! It sets value, uses protected method _getAvatarUrl.

If already exsist overwritten.

direct() : void

inherited

Strategy pattern: currently unutilized

Inherited from: \Zend_View_Helper_Abstract::direct()\Zend_View_Helper_HtmlElement::direct()

getAttribs() : array

Get attribs of image

Warning! If you set src attrib, you get it, but this value will be overwritten in protected method _setSrcAttribForImg(). And finally your get other src value!

Returns

Type	Description
array

getClosingBracket() : string

inherited

Get the tag closing bracket

Inherited from: \Zend_View_Helper_HtmlElement::getClosingBracket()

Returns

Type	Description
string

getDefaultImg() : string

Get default img

Returns

Type	Description
string

getEmail() : string

Get email adress

Returns

Type	Description
string

getImgSize() : int

Get img size

Returns

Type	Description
int	The img size

getImgTag() : string

Return valid image tag

Returns

Type	Description
string

getRating() : string

Get rating value

Returns

Type	Description
string

getSecure() : bool

Get an SSL or a No-SSL location

Returns

Type	Description
bool

gravatar(string | null $email = "", null | array $options = array(), array $attribs = array()) : \Zend_View_Helper_Gravatar

Returns an avatar from gravatar's service.

$options may include the following: - 'img_size' int height of img to return - 'default_img' string img to return if email adress has not found - 'rating' string rating parameter for avatar - 'secure' bool load from the SSL or Non-SSL location

Parameters

Name	Type	Description
$email	string \| null	Email adress.
$options	null \| array	Options
$attribs	array	Attributes for image tag (title, alt etc.)

Returns

Type	Description
\Zend_View_Helper_Gravatar

Details

See: \http://pl.gravatar.com/site/implement/url
See: More information about gravatar's service.

setAttribs(array $attribs) : \Zend_View_Helper_Gravatar

Set attribs for image tag

Warning! You shouldn't set src attrib for image tag. This attrib is overwritten in protected method _setSrcAttribForImg(). This method(_setSrcAttribForImg) is called in public method getImgTag().

Parameters

Name	Type	Description
$attribs	array

Returns

Type	Description
\Zend_View_Helper_Gravatar

setDefaultImg(string $defaultImg) : \Zend_View_Helper_Gravatar

Set default img

Can be either an absolute URL to an image, or one of the DEFAULT_* constants

Parameters

Name	Type	Description
$defaultImg	string

Returns

Type	Description
\Zend_View_Helper_Gravatar

Details

Link: More information about default image.

setEmail(string $email) : \Zend_View_Helper_Gravatar

Set email adress

Parameters

Name	Type	Description
$email	string

Returns

Type	Description
\Zend_View_Helper_Gravatar

setImgSize(int $imgSize) : \Zend_View_Helper_Gravatar

Set img size in pixels

Parameters

Name	Type	Description
$imgSize	int	Size of img must be between 1 and 512

Returns

Type	Description
\Zend_View_Helper_Gravatar

setOptions(array $options) : \Zend_View_Helper_Gravatar

Configure state

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_View_Helper_Gravatar

setRating(string $rating) : void

Set rating value

Must be one of the RATING_* constants

Parameters

Name	Type	Description
$rating	string	Value for rating. Allowed values are: g, px, r,x

Throws

Exception	Description
\Zend_View_Exception

Details

Link: More information about rating.

setSecure(bool $flag) : \Zend_View_Helper_Gravatar

Load from an SSL or No-SSL location?

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_View_Helper_Gravatar

setView(\Zend_View_Interface $view) : \Zend_View_Helper_Abstract

inherited

Set the View object

Inherited from: \Zend_View_Helper_Abstract::setView()\Zend_View_Helper_HtmlElement::setView()

Parameters

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
\Zend_View_Helper_Abstract

View/Helper/Gravatar.php

\Zend_View_Helper_Gravatarjump to top

Constants

Properties

Methods

\Zend_View_Helper_Gravatar
jump to top