PHP Interface Phalcon\Avatar\Avatarable

Defining an interface for classes that use avatars.
Show file Open project: phalcon/incubator

Public Methods

Method Description
getAvatar ( mixed $identity ) : string Gets the avatar URL based on the provided email identity.
getDefaultImage ( ) : mixed Gets the current default image.
getSize ( ) : integer Gets the currently set avatar size.
setDefaultImage ( mixed $image ) Sets the default image to use for avatars.
setSize ( integer $size ) Sets the avatar size to use.

Method Details

getAvatar() public method

Gets the avatar URL based on the provided email identity.
public getAvatar ( mixed $identity ) : string
$identity mixed The identity to get the gravatar for.
return string

getDefaultImage() public method

Gets the current default image.
public getDefaultImage ( ) : mixed
return mixed

getSize() public method

Gets the currently set avatar size.
public getSize ( ) : integer
return integer

setDefaultImage() public method

Sets the default image to use for avatars.
public setDefaultImage ( mixed $image )
$image mixed The default image to use

setSize() public method

Sets the avatar size to use.
public setSize ( integer $size )
$size integer The avatar size to use.