Elgg\EntityIcon Interface Reference

Entities that support icons should implement this interface. More...

Inheritance diagram for Elgg\EntityIcon:

Public Member Functions
	saveIconFromUploadedFile ($input_name, $type='icon', array $coords=array())
	Saves icons using an uploaded file as the source. More...
	saveIconFromLocalFile ($filename, $type='icon', array $coords=array())
	Saves icons using a local file as the source. More...
	saveIconFromElggFile (\ElggFile $file, $type='icon', array $coords=array())
	Saves icons using a file located in the data store as the source. More...
	getIcon ($size, $type='icon')
	Returns entity icon as an ElggIcon object The icon file may or may not exist on filestore. More...
	deleteIcon ($type='icon')
	Removes all icon files and metadata for the passed type of icon. More...
	getIconURL ($params)
	Returns a URL of the icon. More...
	getIconLastChange ($size, $type='icon')
	Returns the timestamp of when the icon was changed. More...
	hasIcon ($size, $type='icon')
	Returns if the entity has an icon of the passed type. More...

Detailed Description

Entities that support icons should implement this interface.

Definition at line 7 of file EntityIcon.php.

Member Function Documentation

deleteIcon()

Elgg\EntityIcon::deleteIcon

(

$type = 'icon'

)

Removes all icon files and metadata for the passed type of icon.

Parameters

string

$type

The name of the icon. e.g., 'icon', 'cover_photo'

Returns

bool

Implemented in ElggEntity.

getIcon()

Elgg\EntityIcon::getIcon	(		$size,
			$type = 'icon'
	)

Returns entity icon as an ElggIcon object The icon file may or may not exist on filestore.

Parameters

string	$size	Size of the icon
string	$type	The name of the icon. e.g., 'icon', 'cover_photo'

Returns

\ElggIcon

Implemented in ElggEntity.

getIconLastChange()

Elgg\EntityIcon::getIconLastChange	(		$size,
			$type = 'icon'
	)

Returns the timestamp of when the icon was changed.

Parameters

string	$size	The size of the icon
string	$type	The name of the icon. e.g., 'icon', 'cover_photo'

Returns

int|null A unix timestamp of when the icon was last changed, or null if not set.

Implemented in ElggEntity.

getIconURL()

Elgg\EntityIcon::getIconURL

(

$params

)

Returns a URL of the icon.

Parameters

array

$params

An array of paramaters including: string 'size' => the size of the icon (default: medium) string 'type' => the icon type (default: icon)

Returns

string

Implemented in ElggEntity.

hasIcon()

Elgg\EntityIcon::hasIcon	(		$size,
			$type = 'icon'
	)

Returns if the entity has an icon of the passed type.

Parameters

string	$size	The size of the icon
string	$type	The name of the icon. e.g., 'icon', 'cover_photo'

Returns

bool

Implemented in ElggEntity.

saveIconFromElggFile()

Elgg\EntityIcon::saveIconFromElggFile	(	\ElggFile	$file,
			$type = 'icon',
		array	$coords = array()
	)

Saves icons using a file located in the data store as the source.

Parameters

string	$file	An ElggFile instance
string	$type	The name of the icon. e.g., 'icon', 'cover_photo'
array	$coords	An array of cropping coordinates x1, y1, x2, y2

Returns

bool

Implemented in ElggEntity.

saveIconFromLocalFile()

Elgg\EntityIcon::saveIconFromLocalFile	(		$filename,
			$type = 'icon',
		array	$coords = array()
	)

Saves icons using a local file as the source.

Parameters

string	$filename	The full path to the local file
string	$type	The name of the icon. e.g., 'icon', 'cover_photo'
array	$coords	An array of cropping coordinates x1, y1, x2, y2

Returns

bool

Implemented in ElggEntity.

saveIconFromUploadedFile()

Elgg\EntityIcon::saveIconFromUploadedFile	(		$input_name,
			$type = 'icon',
		array	$coords = array()
	)

Saves icons using an uploaded file as the source.

Parameters

string	$input_name	Form input name
string	$type	The name of the icon. e.g., 'icon', 'cover_photo'
array	$coords	An array of cropping coordinates x1, y1, x2, y2

Returns

bool

Implemented in ElggEntity.

---

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

• engine/classes/Elgg/EntityIcon.php