|
Elgg
Version 1.9
|
Public Member Functions | |
| __construct ($row=null) | |
| Construct a new annotation object. More... | |
| save () | |
| Save this instance. More... | |
| delete () | |
| Delete the annotation. More... | |
| disable () | |
| Disable the annotation. More... | |
| enable () | |
| Enable the annotation. More... | |
| canEdit ($user_guid=0) | |
| Determines whether or not the user can edit this annotation. More... | |
| getObjectFromID ($id) | |
| For a given ID, return the object associated with it. More... | |
 Public Member Functions inherited from ElggExtender | |
| __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... | |
| getOwner () | |
| Return the guid of the entity's owner. 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... | |
| getObjectOwnerGUID () | |
| Return the GUID of the owner of this 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... | |
Protected Member Functions | |
| initializeAttributes () | |
| (non-PHPdoc) More... | |
| Protected Member Functions inherited from ElggExtender | |
| 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 | |
| initialise_attributes ($pre18_api=true) | |
| Initialise the attributes array. More... | |
| 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 | |
Elgg Annotations.
Annotations allow you to attach bits of information to entities. They are essentially the same as metadata, but with additional helper functions for performing calculations.
Definition at line 14 of file ElggAnnotation.php.
| ElggAnnotation::__construct | ( | $row = null | ) |
Construct a new annotation object.
Plugin developers will probably never use the constructor. See ElggEntity for its API for adding annotations.
| stdClass | $row | Database row as stdClass object |
Definition at line 37 of file ElggAnnotation.php.
| ElggAnnotation::canEdit | ( | $user_guid = 0 | ) |
Determines whether or not the user can edit this annotation.
| int | $user_guid | The GUID of the user (defaults to currently logged in user) |
Definition at line 122 of file ElggAnnotation.php.
| ElggAnnotation::delete | ( | ) |
| ElggAnnotation::disable | ( | ) |
| ElggAnnotation::enable | ( | ) |
| ElggAnnotation::getObjectFromID | ( | $id | ) |
For a given ID, return the object associated with it.
This is used by the river functionality primarily. This is useful for checking access permissions etc on objects.
| int | $id | An annotation ID. |
Implements Loggable.
Definition at line 164 of file ElggAnnotation.php.
|
protected |
(non-PHPdoc)
Definition at line 23 of file ElggAnnotation.php.
| ElggAnnotation::save | ( | ) |
Save this instance.
| IOException |
Definition at line 65 of file ElggAnnotation.php.
1.8.11
