Elgg  Version 4.3
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ElggExtender Class Reference
Inheritance diagram for ElggExtender:
ElggData Elgg\Collections\CollectionItemInterface ElggAnnotation ElggMetadata

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 (array $params=[])
 {} 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...
 
 __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...
 
 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...
 
 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$nameName
Returns
mixed
Exceptions

Definition at line 95 of file ElggExtender.php.

ElggExtender::__set (   $name,
  $value 
)

Set an attribute.

Parameters
string$nameName
mixed$valueValue
Returns
void

Definition at line 61 of file ElggExtender.php.

ElggExtender::canEdit (   $user_guid = 0)
abstract

Returns if a user can edit this entity extender.

Parameters
int$user_guidThe 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$valueThe value
string$value_typeIf specified as "text" or "integer", overrides the detection.
Returns
string

Definition at line 236 of file ElggExtender.php.

ElggExtender::getEntity ( )

Get the entity this describes.

Returns
The entity

Definition at line 145 of file ElggExtender.php.

ElggExtender::getOwnerEntity ( )

Get the entity that owns this extender.

Returns

Definition at line 136 of file ElggExtender.php.

ElggExtender::getOwnerGUID ( )

Get the GUID of the extender's owner entity.

Returns
int The owner GUID

Definition at line 127 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 207 of file ElggExtender.php.

ElggExtender::getSystemLogID ( )

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

This id must be an integer.

Returns
int

Definition at line 188 of file ElggExtender.php.

ElggExtender::getType ( )

Return a type of extension.

Returns
string

Definition at line 197 of file ElggExtender.php.

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

Definition at line 219 of file ElggExtender.php.

ElggExtender::initializeAttributes ( )
protected

{}

Definition at line 43 of file ElggExtender.php.

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

Set the value of the extender.

Parameters
mixed$valueThe value being set
string$value_typeThe type of the : 'integer' or 'text'
Returns
void
Since
1.9

Definition at line 82 of file ElggExtender.php.

ElggExtender::toObject ( array  $params = [])

{}

Definition at line 162 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: