TYPO3\CMS\Backend\Backend\Avatar\Avatar Class Reference

Public Member Functions
string	render (array $backendUser=null, int $size=32, bool $showIcon=false)
string	getImgTag (array $backendUser=null, $size=32)
Image null	getImage (array $backendUser, $size)

Protected Member Functions
	validateSortAndInitiateAvatarProviders ()
BackendUserAuthentication	getBackendUser ()
StandaloneView	getFluidTemplateObject (string $filename=null)
FrontendInterface	getCache ()

Protected Attributes
AvatarProviderInterface[]	$avatarProviders = array( )

Detailed Description

Main class to render an avatar image of a certain Backend user, resolving any avatar provider that takes care of fetching the image.

See render() and getImgTag() as main entry points

Definition at line 32 of file Avatar.php.

Member Function Documentation

getBackendUser()

BackendUserAuthentication TYPO3\CMS\Backend\Backend\Avatar\Avatar::getBackendUser ( )

protected

Returns the current BE user.

Returns

‪BackendUserAuthentication

Definition at line 172 of file Avatar.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Backend\Avatar\Avatar\getImgTag(), and TYPO3\CMS\Backend\Backend\Avatar\Avatar\render().

getCache()

FrontendInterface TYPO3\CMS\Backend\Backend\Avatar\Avatar::getCache ( )

protected

Returns

‪FrontendInterface

Definition at line 203 of file Avatar.php.

Referenced by TYPO3\CMS\Backend\Backend\Avatar\Avatar\render().

getFluidTemplateObject()

StandaloneView TYPO3\CMS\Backend\Backend\Avatar\Avatar::getFluidTemplateObject ( string  $filename = null )

protected

Returns a new standalone view, shorthand function

Parameters

string

$filename

‪Which templateFile should be used.

Returns

‪StandaloneView

Definition at line 183 of file Avatar.php.

Referenced by TYPO3\CMS\Backend\Backend\Avatar\Avatar\render().

getImage()

Image null TYPO3\CMS\Backend\Backend\Avatar\Avatar::getImage	(	array	$backendUser,
			$size
	)

Get Image from first provider that returns one

Parameters

array	$backendUser	‪be_users record
int	$size

Returns

‪Image|null

Definition at line 119 of file Avatar.php.

Referenced by TYPO3\CMS\Backend\Backend\Avatar\Avatar\getImgTag().

getImgTag()

string TYPO3\CMS\Backend\Backend\Avatar\Avatar::getImgTag	(	array	$backendUser = null,
			$size = 32
	)

Returns an HTML tag for the avatar

Parameters

array	$backendUser	‪be_users record
int	$size

Returns

‪string

Definition at line 86 of file Avatar.php.

References TYPO3\CMS\Backend\Backend\Avatar\Avatar\getBackendUser(), TYPO3\CMS\Backend\Backend\Avatar\Avatar\getImage(), and TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix().

Referenced by TYPO3\CMS\Backend\Backend\Avatar\Avatar\render().

render()

string TYPO3\CMS\Backend\Backend\Avatar\Avatar::render	(	array	$backendUser = null,
		int	$size = 32,
		bool	$showIcon = false
	)

Renders an avatar based on a Fluid template which contains some base wrapper classes and does a simple caching functionality, used in Avatar ViewHelper for instance

Parameters

array	$backendUser	‪be_users record
int	$size	‪width and height of the image
bool	$showIcon	‪show the record icon

Returns

‪string

Definition at line 49 of file Avatar.php.

References TYPO3\CMS\Core\Cache\Frontend\FrontendInterface\get(), TYPO3\CMS\Backend\Backend\Avatar\Avatar\getBackendUser(), TYPO3\CMS\Backend\Backend\Avatar\Avatar\getCache(), TYPO3\CMS\Backend\Backend\Avatar\Avatar\getFluidTemplateObject(), TYPO3\CMS\Backend\Backend\Avatar\Avatar\getImgTag(), TYPO3\CMS\Core\Cache\Frontend\FrontendInterface\set(), and TYPO3\CMS\Backend\Backend\Avatar\Avatar\validateSortAndInitiateAvatarProviders().

validateSortAndInitiateAvatarProviders()

TYPO3\CMS\Backend\Backend\Avatar\Avatar::validateSortAndInitiateAvatarProviders ( )

protected

Validates the registered avatar providers

Exceptions

Definition at line 135 of file Avatar.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Backend\Avatar\Avatar\render().

Member Data Documentation

$avatarProviders

AvatarProviderInterface [] TYPO3\CMS\Backend\Backend\Avatar\Avatar::$avatarProviders = array( )

protected

Array of sorted and initialized avatar providers

Definition at line 38 of file Avatar.php.