Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Protected Member Functions | List of all members
ElggExtender Class Reference
Inheritance diagram for ElggExtender:
ElggData Loggable Exportable 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 ()
 {} 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...
 
 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 ()
 Get a plain old object copy for public consumption. 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...
 

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
 initializeAttributes ()
 Initialize the attributes array. More...
 
 getDatabase ()
 Provides a pointer to the database object. More...
 
 get ($name)
 Fetch the specified attribute. 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

ElggExtender::__get (   $name)

Gets an attribute.

Parameters
string$nameName
Returns
mixed

Definition at line 100 of file ElggExtender.php.

ElggExtender::__set (   $name,
  $value 
)

Set an attribute.

Parameters
string$nameName
mixed$valueValue
Returns
void

Definition at line 53 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
See Also
elgg_set_ignore_access()
ElggExtender::export ( )

Export this object.

Returns
array

Implements Exportable.

Definition at line 218 of file ElggExtender.php.

ElggExtender::get (   $name)
protected

Returns an attribute.

Parameters
string$nameName
Returns
mixed

Definition at line 130 of file ElggExtender.php.

ElggExtender::getEntity ( )

Get the entity this describes.

Returns
The entity

Definition at line 158 of file ElggExtender.php.

ElggExtender::getExportableValues ( )

Return an array of fields which can be exported.

Returns
array

Implements Exportable.

Definition at line 199 of file ElggExtender.php.

ElggExtender::getOwnerEntity ( )

Get the entity that owns this extender.

Returns

Definition at line 149 of file ElggExtender.php.

ElggExtender::getOwnerGUID ( )

Get the GUID of the extender's owner entity.

Returns
int The owner GUID

Definition at line 140 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

Implements Loggable.

Definition at line 258 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

Implements Loggable.

Definition at line 239 of file ElggExtender.php.

ElggExtender::getType ( )

Return a type of extension.

Returns
string

Implements Loggable.

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

ElggExtender::initializeAttributes ( )
protected

(non-PHPdoc)

See Also
::initializeAttributes()
Returns
void

Definition at line 35 of file ElggExtender.php.

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

Set an attribute.

Parameters
string$nameName
mixed$valueValue
string$value_typeValue type
Returns
boolean

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

ElggExtender::toObject ( )

{}

Definition at line 176 of file ElggExtender.php.


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