Class ElggAnnotation

Elgg Annotations

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

ElggData implements Loggable, Iterator, ArrayAccess, Exportable

ElggExtender

ElggAnnotation

Package: Elgg\Core\DataModel\Annotations
Link: http://docs.elgg.org/DataModel/Annotations
Located at ElggAnnotation.php

Methods summary
`protected`	# `initializeAttributes( )` (non-PHPdoc) (non-PHPdoc) See `ElggData::initializeAttributes()` Overrides `ElggExtender::initializeAttributes()`
`public`	# `__construct( mixed $id = null )` Construct a new annotation object Construct a new annotation object Parameters `$id` `mixed` $id The annotation ID or a database row as stdClass object
`public integer`	# `save( )` Save this instance Save this instance Returns `integer` an object id Throws `IOException`
`public boolean`	# `delete( )` Delete the annotation. Delete the annotation. Returns `boolean`
`public boolean`	# `disable( )` Disable the annotation. Disable the annotation. Returns `boolean` Since 1.8
`public boolean`	# `enable( )` Enable the annotation. Enable the annotation. Returns `boolean` Since 1.8
`public string`	# `getURL( )` Get a url for this annotation. Get a url for this annotation. Returns `string`
`public ElggAnnotation`	# `getObjectFromID( integer $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. 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 `$id` `integer` $id An annotation ID. Returns `ElggAnnotation`

Methods inherited from ElggExtender
`canEdit(), export(), get(), getEntity(), getExportableValues(), getOwnerEntity(), getOwnerGUID(), getSubtype(), getSystemLogID(), getType(), set()`

Methods inherited from ElggData
`__get(), __isset(), __set(), current(), getClassName(), getTimeCreated(), key(), next(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), rewind(), valid()`

Properties inherited from ElggData
`$attributes, $valid`

Magic properties summary
`public string`	`$value_type`	#
`public string`	`$enabled`	#

Magic properties inherited from ElggExtender
`$access_id, $entity_guid, $id, $name, $time_created, $type, $value`

Magic properties inherited from ElggData
`$owner_guid`