API Documentation

Zend/View/Helper/Gravatar.php

Show: inherited
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

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

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

URL to gravatar service

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

Secure URL to gravatar service

Constant  RATING_G = 'g'

Gravatar rating

Constant  RATING_PG = 'pg'
Constant  RATING_R = 'r'
Constant  RATING_X = 'x'
Constant  DEFAULT_404 = '404'

Default gravatar image value constants

Constant  DEFAULT_MM = 'mm'
Constant  DEFAULT_IDENTICON = 'identicon'
Constant  DEFAULT_MONSTERID = 'monsterid'
Constant  DEFAULT_WAVATAR = 'wavatar'

Properties

Propertyprotectedarray  $_attribs= ''

Attributes for HTML image tag

Details
Type
array
Propertyprotectedstring  $_email= ''

Email Adress

Details
Type
string
Propertyprotectedarray  $_options= 'array( 'img_size' => 80'

Options

Default valuearray( 'img_size' => 80Details
Type
array

Methods

methodpublic__toString( ) : string

Return valid image tag

Returns
Type Description
string
methodprotected_getAvatarUrl( ) : string

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

Returns
Type Description
string
methodprotected_getGravatarUrl( ) : string

Get URL to gravatar's service.

Returns
Type Description
string URL
methodprotected_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.

methodpublicgetAttribs( ) : 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
methodpublicgetDefaultImg( ) : string

Get default img

Returns
Type Description
string
methodpublicgetEmail( ) : string

Get email adress

Returns
Type Description
string
methodpublicgetImgSize( ) : int

Get img size

Returns
Type Description
int The img size
methodpublicgetImgTag( ) : string

Return valid image tag

Returns
Type Description
string
methodpublicgetRating( ) : string

Get rating value

Returns
Type Description
string
methodpublicgetSecure( ) : bool

Get an SSL or a No-SSL location

Returns
Type Description
bool
methodpublicgravatar( 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
\http://pl.gravatar.com/site/implement/url  
methodpublicsetAttribs( 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
methodpublicsetDefaultImg( 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.  
methodpublicsetEmail( string $email ) : \Zend_View_Helper_Gravatar

Set email adress

Parameters
Name Type Description
$email string
Returns
Type Description
\Zend_View_Helper_Gravatar
methodpublicsetImgSize( 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
methodpublicsetOptions( array $options ) : \Zend_View_Helper_Gravatar

Configure state

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_View_Helper_Gravatar
methodpublicsetRating( 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.  
methodpublicsetSecure( 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
Documentation was generated by DocBlox 0.15.1.