Entity icon service. More...

Public Member Functions
	__construct (Config $config, PluginHooksService $hooks, EntityTable $entities, UploadService $uploads, ImageService $images, MimeTypeService $mimetype, HttpRequest $request)
	Constructor. More...

	saveIconFromUploadedFile (\ElggEntity $entity, $input_name, $type= 'icon', array $coords=[])
	Saves icons using an uploaded file as the source. More...

	saveIconFromLocalFile (\ElggEntity $entity, $filename, $type= 'icon', array $coords=[])
	Saves icons using a local file as the source. More...

	saveIconFromElggFile (\ElggEntity $entity,\ElggFile $file, $type= 'icon', array $coords=[])
	Saves icons using a file located in the data store as the source. More...

	saveIcon (\ElggEntity $entity,\ElggFile $file, $type= 'icon', array $coords=[])
	Saves icons using a created temporary file. More...

	getIcon (\ElggEntity $entity, $size, $type= 'icon', $generate=true)
	Returns entity icon as an ElggIcon object The icon file may or may not exist on filestore. More...

	deleteIcon (\ElggEntity $entity, $type= 'icon', $retain_master=false)
	Removes all icon files and metadata for the passed type of icon. More...

	getIconURL (\ElggEntity $entity, $params=[])
	Get the URL for this entity's icon. More...

	getFallbackIconUrl (\ElggEntity $entity, array $params=[])
	Returns default/fallback icon. More...

	getIconLastChange (\ElggEntity $entity, $size, $type= 'icon')
	Returns the timestamp of when the icon was changed. More...

	hasIcon (\ElggEntity $entity, $size, $type= 'icon')
	Returns if the entity has an icon of the passed type. More...

	getSizes ($entity_type=null, $entity_subtype=null, $type= 'icon')
	Returns a configuration array of icon sizes. More...

Protected Member Functions
	prepareIcon ($filename)
	Prepares an icon. More...

	generateIcon (\ElggEntity $entity,\ElggFile $file, $type= 'icon', $coords=[], $icon_size= '')
	Generate an icon for the given entity. More...

	detectCroppingCoordinates (string $input_name)
	Automagicly detect cropping coordinates. More...

	hasWebPSupport ()
	Checks if browser has WebP support and if the webserver is able to generate. More...

Protected Attributes
	$mimetype

	$request

Detailed Description

Entity icon service.

Definition at line 19 of file EntityIconService.php.

Constructor & Destructor Documentation

Elgg\EntityIconService::__construct	(	Config	$config,
		PluginHooksService	$hooks,
		EntityTable	$entities,
		UploadService	$uploads,
		ImageService	$images,
		MimeTypeService	$mimetype,
		HttpRequest	$request
	)

Constructor.

Parameters

Config	$config	Config
PluginHooksService	$hooks	Hook registration service
EntityTable	$entities	Entity table
UploadService	$uploads	Upload service
ImageService	$images	Image service
MimeTypeService	$mimetype	MimeType service
Request	$request	Http Request service

Definition at line 70 of file EntityIconService.php.

Member Function Documentation

Elgg\EntityIconService::deleteIcon	(	\ElggEntity	$entity,
			$type = `'icon'`,
			$retain_master = `false`
	)

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

Parameters

\ElggEntity	$entity	Entity that owns icons
string	$type	The name of the icon. e.g., 'icon', 'cover_photo'
bool	$retain_master	Keep the master icon (default: false)

Returns: bool

Definition at line 487 of file EntityIconService.php.

Elgg\EntityIconService::detectCroppingCoordinates ( string $input_name )

protected

Automagicly detect cropping coordinates.

Based in the input names x1, x2, y1 and y2

Parameters

string $input_name the file input name which is the prefix for the cropping coordinates

Returns: false|array

Definition at line 710 of file EntityIconService.php.

Elgg\EntityIconService::generateIcon	(	\ElggEntity	$entity,
		\ElggFile	$file,
			$type = `'icon'`,
			$coords = `[]`,
			$icon_size = `''`
	)

protected

Generate an icon for the given entity.

Parameters

\ElggEntity	$entity	Temporary ElggFile instance
\ElggFile	$file	Temporary 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
string	$icon_size	The icon size to generate (leave empty to generate all supported sizes)

Returns: bool

Definition at line 336 of file EntityIconService.php.

Elgg\EntityIconService::getFallbackIconUrl	(	\ElggEntity	$entity,
		array	$params = `[]`
	)

Returns default/fallback icon.

Parameters

\ElggEntity	$entity	Entity
array	$params	Icon params

Returns: string

Definition at line 596 of file EntityIconService.php.

Elgg\EntityIconService::getIcon	(	\ElggEntity	$entity,
			$size,
			$type = `'icon'`,
			$generate = `true`
	)

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

Note: Returned ElggIcon object may be a placeholder. Use ElggIcon::exists() to validate if file has been written to filestore

Parameters

\ElggEntity	$entity	Entity that owns the icon
string	$size	Size of the icon
string	$type	The name of the icon. e.g., 'icon', 'cover_photo'
bool	$generate	Try to generate an icon based on master if size doesn't exists

Returns

Exceptions

InvalidParameterException

Definition at line 419 of file EntityIconService.php.

Elgg\EntityIconService::getIconLastChange	(	\ElggEntity	$entity,
			$size,
			$type = `'icon'`
	)

Returns the timestamp of when the icon was changed.

Parameters

\ElggEntity	$entity	Entity that owns the icon
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.

Definition at line 631 of file EntityIconService.php.

Elgg\EntityIconService::getIconURL	(	\ElggEntity	$entity,
			$params = `[]`
	)

Get the URL for this entity's icon.

Plugins can register for the 'entity:icon:url', <type> plugin hook to customize the icon for an entity.

Parameters

\ElggEntity	$entity	Entity that owns the icon
mixed	$params	A string defining the size of the icon (e.g. tiny, small, medium, large) or an array of parameters including 'size'

Returns: string|void

Definition at line 556 of file EntityIconService.php.

Elgg\EntityIconService::getSizes	(	$entity_type = `null`,
		$entity_subtype = `null`,
		$type = `'icon'`
	)

Returns a configuration array of icon sizes.

Parameters

string	$entity_type	Entity type
string	$entity_subtype	Entity subtype
string	$type	The name of the icon. e.g., 'icon', 'cover_photo'

Returns: array

Exceptions

InvalidParameterException

Definition at line 662 of file EntityIconService.php.

Elgg\EntityIconService::hasIcon	(	\ElggEntity	$entity,
			$size,
			$type = `'icon'`
	)

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

Parameters

\ElggEntity	$entity	Entity that owns the icon
string	$size	The size of the icon
string	$type	The name of the icon. e.g., 'icon', 'cover_photo'

Returns: bool

Definition at line 647 of file EntityIconService.php.

Elgg\EntityIconService::hasWebPSupport ( )

protected

Checks if browser has WebP support and if the webserver is able to generate.

Returns: bool

Definition at line 745 of file EntityIconService.php.

Elgg\EntityIconService::prepareIcon ( $filename )

protected

Prepares an icon.

Parameters

string $filename the file to prepare

Returns: void

Definition at line 308 of file EntityIconService.php.

Elgg\EntityIconService::saveIcon	(	\ElggEntity	$entity,
		\ElggFile	$file,
			$type = `'icon'`,
		array	$coords = `[]`
	)

Saves icons using a created temporary file.

Parameters

\ElggEntity	$entity	Temporary ElggFile instance
\ElggFile	$file	Temporary 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

Definition at line 205 of file EntityIconService.php.

Elgg\EntityIconService::saveIconFromElggFile	(	\ElggEntity	$entity,
		\ElggFile	$file,
			$type = `'icon'`,
		array	$coords = `[]`
	)

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

Parameters

\ElggEntity	$entity	Entity to own the icons
\ElggFile	$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

Exceptions

InvalidParameterException

Definition at line 173 of file EntityIconService.php.

Elgg\EntityIconService::saveIconFromLocalFile	(	\ElggEntity	$entity,
			$filename,
			$type = `'icon'`,
		array	$coords = `[]`
	)

Saves icons using a local file as the source.

Parameters

\ElggEntity	$entity	Entity to own the icons
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

Exceptions

InvalidParameterException

Definition at line 140 of file EntityIconService.php.

Elgg\EntityIconService::saveIconFromUploadedFile	(	\ElggEntity	$entity,
			$input_name,
			$type = `'icon'`,
		array	$coords = `[]`
	)

Saves icons using an uploaded file as the source.

Parameters

\ElggEntity	$entity	Entity to own the icons
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

Definition at line 98 of file EntityIconService.php.

Member Data Documentation

Elgg\EntityIconService::$mimetype

protected

Definition at line 52 of file EntityIconService.php.

Elgg\EntityIconService::$request

protected

Definition at line 57 of file EntityIconService.php.

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

engine/classes/Elgg/EntityIconService.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation