ElggExtender Class Reference

Inheritance diagram for ElggExtender:

Public Member Functions
	__set ($name, $value)
	Set an attribute. More...
	setValue ($value, string $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 (int $user_guid=0)
	Returns if a user can edit this entity extender. More...
	toObject (array $params=[])
	{} More...
	getSystemLogID ()
	{} 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...
	__unset ($name)
	Unset a property from metadata or attribute. More...
	getURL ()
	Get a URL for this object. 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...
	toObject (array $params=[])
	Get a plain old object copy for public consumption. More...
	getSystemLogID ()
	Return an identification for the object for storage in the system log. More...
	getType ()
	Return the type of the object - eg. More...
	getSubtype ()
	Return a subtype. More...
	getObjectFromID (int $id)
	For a given ID, return the object associated with it. More...
	rewind ()
	Iterator interface. More...
	current ()
	Iterator interface. More...
	key ()
	Iterator interface. More...
	next ()
	Iterator interface. More...
	valid ()
	Iterator interface. More...
	offsetSet ($offset, $value)
	Array access interface. More...
	offsetGet ($offset)
	Array access interface. More...
	offsetUnset ($offset)
	Array access interface. More...
	offsetExists ($offset)
	Array access interface. More...
	getID ()
	{Get unique item identifier within a collection. Returns string|int } More...
	getPriority ()
	{Get priority (weight) of the item within a collection. Returns int } More...
	__serialize ()
	Called during serialization. More...
	__unserialize (array $data)
	Called during unserialization. More...

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

Protected Member Functions
	initializeAttributes ()
	{} More...
Protected Member Functions inherited from ElggData
	initializeAttributes ()
	Initialize the attributes array. More...
	getDatabase ()
	Provides a pointer to the database object. More...

Protected Attributes
const	INTEGER_ATTR_NAMES
Protected Attributes inherited from ElggData
	$attributes = []
	$valid = false

Detailed Description

Definition at line 27 of file ElggExtender.php.

Member Function Documentation

ElggExtender::__get

(

$name

)

Gets an attribute.

Parameters

string

$name

Name

Returns

mixed

Exceptions

Definition at line 97 of file ElggExtender.php.

ElggExtender::__set	(		$name,
			$value
	)

Set an attribute.

Parameters

string	$name	Name
mixed	$value	Value

Returns

void

Definition at line 61 of file ElggExtender.php.

ElggExtender::canEdit ( int  $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

static ElggExtender::detectValueType (   $value, string  $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

Definition at line 234 of file ElggExtender.php.

ElggExtender::getEntity

(

)

Get the entity this describes.

Returns

|null

Definition at line 146 of file ElggExtender.php.

ElggExtender::getOwnerEntity

(

)

Get the entity that owns this extender.

Returns

|null

Definition at line 137 of file ElggExtender.php.

ElggExtender::getOwnerGUID

(

)

Get the GUID of the extender's owner entity.

Returns

int The owner GUID

Definition at line 128 of file ElggExtender.php.

ElggExtender::getSubtype

(

)

Return a subtype.

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

Returns

string

Definition at line 205 of file ElggExtender.php.

ElggExtender::getSystemLogID

(

)

{}

Definition at line 186 of file ElggExtender.php.

ElggExtender::getType

(

)

Return a type of extension.

Returns

string

Definition at line 195 of file ElggExtender.php.

ElggExtender::getURL

(

)

Get a url for this extender.

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

Returns

string

Definition at line 217 of file ElggExtender.php.

ElggExtender::initializeAttributes ( )

protected

{}

Definition at line 43 of file ElggExtender.php.

ElggExtender::setValue	(		$value,
		string	$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 84 of file ElggExtender.php.

ElggExtender::toObject

(

array

$params = []

)

{}

Definition at line 163 of file ElggExtender.php.

Member Data Documentation

const ElggExtender::INTEGER_ATTR_NAMES

protected

Initial value:

= [
        'id',
        'entity_guid',
        'owner_guid',
        'access_id',
        'time_created',
    ]

Definition at line 32 of file ElggExtender.php.

---

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

• engine/classes/ElggExtender.php