ElggAnnotation Class Reference

Elgg Annotations. More...

Inheritance diagram for ElggAnnotation:
ElggExtender ElggData Loggable Exportable

List of all members.

Public Member Functions

 __construct ($id=null)
 Construct a new annotation object.
 save ()
 Save this instance.
 delete ()
 Delete the annotation.
 disable ()
 Disable the annotation.
 enable ()
 Enable the annotation.
 getURL ()
 Get a url for this annotation.
 getObjectFromID ($id)
 For a given ID, return the object associated with it.

Protected Member Functions

 initializeAttributes ()
 (non-PHPdoc)

Detailed Description

Elgg Annotations.

Annotations allow you to attach bits of information to entities. They are essentially the same as metadata, but with additional helper functions.

Definition at line 18 of file ElggAnnotation.php.


Constructor & Destructor Documentation

ElggAnnotation::__construct ( id = null  ) 

Construct a new annotation object.

Parameters:
mixed $id The annotation ID or a database row as stdClass object

Definition at line 38 of file ElggAnnotation.php.


Member Function Documentation

ElggAnnotation::delete (  ) 

Delete the annotation.

Returns:
bool

Reimplemented from ElggData.

Definition at line 85 of file ElggAnnotation.php.

ElggAnnotation::disable (  ) 

Disable the annotation.

Returns:
bool
Since:
1.8

Definition at line 96 of file ElggAnnotation.php.

ElggAnnotation::enable (  ) 

Enable the annotation.

Returns:
bool
Since:
1.8

Definition at line 106 of file ElggAnnotation.php.

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.

Parameters:
int $id An annotation ID.
Returns:
ElggAnnotation

Implements Loggable.

Definition at line 130 of file ElggAnnotation.php.

ElggAnnotation::getURL (  ) 

Get a url for this annotation.

Returns:
string

Reimplemented from ElggData.

Definition at line 115 of file ElggAnnotation.php.

ElggAnnotation::initializeAttributes (  )  [protected]

(non-PHPdoc)

See also:
ElggData::initializeAttributes()
Returns:
void

Reimplemented from ElggExtender.

Definition at line 27 of file ElggAnnotation.php.

ElggAnnotation::save (  ) 

Save this instance.

Returns:
int an object id
Exceptions:
IOException 

Reimplemented from ElggData.

Definition at line 65 of file ElggAnnotation.php.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations
Generated on Wed May 22 00:01:24 2013 for Elgg by  doxygen 1.6.3