Elgg  Version 3.0
Public Member Functions | Protected Member Functions | List of all members
ElggAnnotation Class Reference

Entity Annotation. More...

Inheritance diagram for ElggAnnotation:
ElggExtender ElggData Elgg\Collections\CollectionItemInterface

Public Member Functions

 __construct (stdClass $row=null)
 Constructor. More...
 
 save ()
 Save this instance and returns an annotation ID. 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)
 {} 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...
 
 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 ()
 {} More...
 
 unserialize ($serialized)
 {} More...
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from ElggExtender
static detectValueType ($value, $value_type="")
 Detect the value_type for a value to be stored as metadata or an annotation. More...
 
- Protected Attributes inherited from ElggExtender
 $int_columns
 
- Protected Attributes inherited from ElggData
 $attributes = []
 The main attributes of an entity. More...
 
 $valid = false
 

Detailed Description

Entity Annotation.

Annotations allow you to attach bits of information to entities. Unlike entity metadata, annotation is access controlled and has owners.

Definition at line 9 of file ElggAnnotation.php.

Constructor & Destructor Documentation

ElggAnnotation::__construct ( stdClass  $row = null)

Constructor.

Parameters
stdClass$rowDatabase row

Definition at line 25 of file ElggAnnotation.php.

Member Function Documentation

ElggAnnotation::canEdit (   $user_guid = 0)

Determines whether or not the user can edit this annotation.

Parameters
int$user_guidThe GUID of the user (defaults to currently logged in user)
Returns
bool
See also
elgg_set_ignore_access()

Definition at line 102 of file ElggAnnotation.php.

ElggAnnotation::delete ( )

Delete the annotation.

Returns
bool

Definition at line 70 of file ElggAnnotation.php.

ElggAnnotation::disable ( )

Disable the annotation.

Returns
bool
Since
1.8

Definition at line 80 of file ElggAnnotation.php.

ElggAnnotation::enable ( )

Enable the annotation.

Returns
bool
Since
1.8

Definition at line 90 of file ElggAnnotation.php.

ElggAnnotation::getObjectFromID (   $id)

{}

Definition at line 111 of file ElggAnnotation.php.

ElggAnnotation::initializeAttributes ( )
protected

{}

Definition at line 14 of file ElggAnnotation.php.

ElggAnnotation::save ( )

Save this instance and returns an annotation ID.

Returns
int|bool

Definition at line 40 of file ElggAnnotation.php.


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