ElggAnnotation Class Reference

Entity Annotation. More...

Inheritance diagram for ElggAnnotation:

Public Member Functions
	__construct (?\stdClass $row=null)
	Constructor. More...
	save ()
	Save this instance and returns an annotation ID. More...
	delete ()
	Delete the annotation. More...
	canEdit (int $user_guid=0)
	Determines whether or not the user can edit this annotation. More...
	getObjectFromID (int $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 GUID of an entity Returns static|false } More...
Public Member Functions inherited from ElggExtender
	__set ($name, $value)
	Set an attribute. More...
	setValue ($value, string $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...
	toObject (array $params=[])
	{Get a plain old object copy for public consumption. Parameters array $params Export parameters Returns \Elgg\Export\Data } More...
	getSystemLogID ()
	{Return an identification for the object for storage in the system log.This id must be an integer. Unsaved implementations should return 0. Returns int } 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...
	getTimeCreated ()
	Returns the UNIX epoch time that this entity was created. More...
	rewind ()
	Iterator interface. More...
	current ()
	Iterator interface. More...
	key ()
	Iterator interface. More...
	next ()
	Iterator interface. More...
	valid ()
	Iterator interface. More...
	offsetSet ($offset, $value)
	Array access interface. More...
	offsetGet ($offset)
	Array access interface. More...
	offsetUnset ($offset)
	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...

Protected Member Functions
	initializeAttributes ()
	{{Initialize the attributes array.This is vital to distinguish between metadata and base parameters. Returns void }} More...
Protected Member Functions inherited from ElggData
	getDatabase ()
	Provides a pointer to the database object. More...

Additional Inherited Members
Static Public Member Functions inherited from ElggExtender
static	detectValueType ($value, string $value_type='')
	Detect the value_type for a value to be stored as metadata or an annotation. More...
Protected Attributes inherited from ElggExtender
const	INTEGER_ATTR_NAMES
Protected Attributes inherited from ElggData
	$attributes = []
	$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.

Examples

/root/Elgg/engine/lib/views.php.

Definition at line 9 of file ElggAnnotation.php.

Constructor & Destructor Documentation

__construct()

ElggAnnotation::__construct

(

?\stdClass

$row = null

)

Constructor.

Parameters

null | \stdClass

$row

Database row

Definition at line 25 of file ElggAnnotation.php.

Member Function Documentation

canEdit()

ElggAnnotation::canEdit

(

int

$user_guid = 0

)

Determines whether or not the user can edit this annotation.

Parameters

int

$user_guid

The GUID of the user (defaults to currently logged in user)

Returns

bool

Reimplemented from ElggExtender.

Definition at line 85 of file ElggAnnotation.php.

delete()

ElggAnnotation::delete

(

)

Delete the annotation.

Returns

bool

Reimplemented from ElggData.

Definition at line 74 of file ElggAnnotation.php.

getObjectFromID()

ElggAnnotation::getObjectFromID

(

int

$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

GUID of an entity

Returns

static|false

}

Reimplemented from ElggData.

Definition at line 92 of file ElggAnnotation.php.

initializeAttributes()

ElggAnnotation::initializeAttributes ( )

protected

{{Initialize the attributes array.This is vital to distinguish between metadata and base parameters.

Returns

void

}}

Reimplemented from ElggExtender.

Definition at line 14 of file ElggAnnotation.php.

save()

ElggAnnotation::save

(

)

Save this instance and returns an annotation ID.

Returns

bool

Reimplemented from ElggData.

Definition at line 40 of file ElggAnnotation.php.

---

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

• engine/classes/ElggAnnotation.php