Inheritance diagram for ElggExtender:

Public Member Functions
	__set ($name, $value)
	Set an attribute. More...

	setValue ($value, $value_type='')
	Set the value of the extender. More...

	__get ($name)
	Gets an attribute. More...

	getOwnerGUID ()
	Get the GUID of the extender's owner entity. More...

	getOwnerEntity ()
	Get the entity that owns this extender. More...

	getEntity ()
	Get the entity this describes. More...

	canEdit ($user_guid=0)
	Returns if a user can edit this entity extender. More...

	toObject ()
	{Get a plain old object copy for public consumption. Returns \stdClass } More...

	getExportableValues ()
	Return an array of fields which can be exported. More...

	export ()
	Export this object. More...

	getSystemLogID ()
	Return an identification for the object for storage in the system log. More...

	getType ()
	Return a type of extension. More...

	getSubtype ()
	Return a subtype. More...

	getURL ()
	Get a url for this extender. More...

Public Member Functions inherited from ElggData
	__isset ($name)
	Test if property is set either as an attribute or metadata. More...

	save ()
	Save this data to the appropriate database table. More...

	delete ()
	Delete this data. More...

	getTimeCreated ()
	Returns the UNIX epoch time that this entity was created. More...

	getClassName ()
	Return the class name of the object. More...

	rewind ()
	Iterator interface. More...

	current ()
	Iterator interface. More...

	key ()
	Iterator interface. More...

	next ()
	Iterator interface. More...

	valid ()
	Iterator interface. More...

	offsetSet ($key, $value)
	Array access interface. More...

	offsetGet ($key)
	Array access interface. More...

	offsetUnset ($key)
	Array access interface. More...

	offsetExists ($offset)
	Array access interface. More...

Public Member Functions inherited from Loggable
	getObjectFromID ($id)
	For a given ID, return the object associated with it. More...

Static Public Member Functions
static	detectValueType ($value, $value_type="")
	Detect the value_type for a value to be stored as metadata or an annotation. More...

Protected Member Functions
	initializeAttributes ()
	(non-PHPdoc) More...

	set ($name, $value, $value_type='')
	Set an attribute. More...

	get ($name)
	Returns an attribute. More...

Protected Member Functions inherited from ElggData
	getDatabase ()
	Provides a pointer to the database object. More...

	set ($name, $value)
	Set the specified attribute. More...

Additional Inherited Members
Protected Attributes inherited from ElggData
	$attributes = array()
	The main attributes of an entity. More...

	$valid = false

Detailed Description

Definition at line 26 of file ElggExtender.php.

Member Function Documentation

◆ __get()

ElggExtender::__get ( $name )

Gets an attribute.

Parameters

string $name Name

Returns: mixed

Definition at line 105 of file ElggExtender.php.

◆ __set()

ElggExtender::__set	(	$name,
		$value
	)

Set an attribute.

Parameters

string	$name	Name
mixed	$value	Value

Returns: void

Definition at line 53 of file ElggExtender.php.

◆ canEdit()

ElggExtender::canEdit ( $user_guid = 0 )

abstract

Returns if a user can edit this entity extender.

Parameters

int $user_guid The GUID of the user doing the editing (defaults to currently logged in user)

Returns: bool

See also: elgg_set_ignore_access()

Reimplemented in ElggMetadata, and ElggAnnotation.

◆ detectValueType()

static ElggExtender::detectValueType	(	$value,
		$value_type = `""`
	)

static

Detect the value_type for a value to be stored as metadata or an annotation.

Parameters

mixed	$value	The value
string	$value_type	If specified as "text" or "integer", overrides the detection.

Returns: string @access private

Definition at line 328 of file ElggExtender.php.

◆ export()

ElggExtender::export ( )

Export this object.

Returns: array

Implements Exportable.

Definition at line 231 of file ElggExtender.php.

◆ get()

ElggExtender::get ( $name )

protected

Returns an attribute.

Parameters

string $name Name

Returns: mixed

Reimplemented from ElggData.

Definition at line 135 of file ElggExtender.php.

◆ getEntity()

ElggExtender::getEntity ( )

Get the entity this describes.

Returns: \ElggEntity The entity

Definition at line 163 of file ElggExtender.php.

◆ getExportableValues()

ElggExtender::getExportableValues ( )

Return an array of fields which can be exported.

Returns: array

Implements Exportable.

Definition at line 212 of file ElggExtender.php.

◆ getOwnerEntity()

ElggExtender::getOwnerEntity ( )

Get the entity that owns this extender.

Returns: \ElggEntity

Definition at line 154 of file ElggExtender.php.

◆ getOwnerGUID()

ElggExtender::getOwnerGUID ( )

Get the GUID of the extender's owner entity.

Returns: int The owner GUID

Definition at line 145 of file ElggExtender.php.

◆ getSubtype()

ElggExtender::getSubtype ( )

Return a subtype.

For metadata & annotations this is the 'name' and for relationship this is the relationship type.

Returns: string

Implements Loggable.

Definition at line 271 of file ElggExtender.php.

◆ getSystemLogID()

ElggExtender::getSystemLogID ( )

Return an identification for the object for storage in the system log.

This id must be an integer.

Returns: int

Implements Loggable.

Definition at line 252 of file ElggExtender.php.

◆ getType()

ElggExtender::getType ( )

Return a type of extension.

Returns: string

Implements Loggable.

Definition at line 261 of file ElggExtender.php.

◆ getURL()

ElggExtender::getURL ( )

Get a url for this extender.

Plugins can register for the 'extender:url', <type> plugin hook to customize the url for an annotation or metadata.

Returns: string

Reimplemented from ElggData.

Definition at line 283 of file ElggExtender.php.

◆ initializeAttributes()

ElggExtender::initializeAttributes ( )

protected

(non-PHPdoc)

See also: \ElggData::initializeAttributes()

Returns: void

Reimplemented from ElggData.

Reimplemented in ElggMetadata, and ElggAnnotation.

Definition at line 35 of file ElggExtender.php.

◆ set()

ElggExtender::set	(	$name,
		$value,
		$value_type = `''`
	)

protected

Set an attribute.

Parameters

string	$name	Name
mixed	$value	Value
string	$value_type	Value type

Returns: boolean

Definition at line 88 of file ElggExtender.php.

◆ setValue()

ElggExtender::setValue	(	$value,
		$value_type = `''`
	)

Set the value of the extender.

Parameters

mixed	$value	The value being set
string	$value_type	The type of the : 'integer' or 'text'

Returns: void

Since: 1.9

Definition at line 73 of file ElggExtender.php.

◆ toObject()

ElggExtender::toObject ( )

{Get a plain old object copy for public consumption.

Returns: \stdClass

}

Reimplemented from ElggData.

Definition at line 181 of file ElggExtender.php.

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

engine/classes/ElggExtender.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ __get()

◆ __set()

◆ canEdit()

◆ detectValueType()

◆ export()

◆ get()

◆ getEntity()

◆ getExportableValues()

◆ getOwnerEntity()

◆ getOwnerGUID()

◆ getSubtype()

◆ getSystemLogID()

◆ getType()

◆ getURL()

◆ initializeAttributes()

◆ set()

◆ setValue()

◆ toObject()