ElggRiverItem Class Reference

Public Member Functions
	__construct ($object)
	Construct a river item object given a database row. More...
	getSubjectEntity ()
	Get the subject of this river item. More...
	getObjectEntity ()
	Get the object of this river item. More...
	getTargetEntity ()
	Get the target of this river item. More...
	getAnnotation ()
	Get the Annotation for this river item. More...
	getView ()
	Get the view used to display this river item. More...
	getPostedTime ()
	Get the time this activity was posted. More...
	getTimePosted ()
	Get the time this activity was posted. More...
	getType ()
	Get the type of the object. More...
	getSubtype ()
	Get the subtype of the object. More...
	toObject ()
	Get a plain old object copy for public consumption. More...

Public Attributes
	$id
	$subject_guid
	$object_guid
	$target_guid
	$annotation_id
	$type
	$subtype
	$action_type
	$access_id
	$view
	$posted
	$enabled

Detailed Description

Examples:

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

Definition at line 21 of file ElggRiverItem.php.

Constructor & Destructor Documentation

ElggRiverItem::__construct

(

$object

)

Construct a river item object given a database row.

Parameters

stdClass

$object

Object obtained from database

Definition at line 40 of file ElggRiverItem.php.

Member Function Documentation

ElggRiverItem::getAnnotation

(

)

Get the Annotation for this river item.

Returns

ElggAnnotation

Definition at line 88 of file ElggRiverItem.php.

ElggRiverItem::getObjectEntity

(

)

Get the object of this river item.

Returns

ElggEntity

Definition at line 70 of file ElggRiverItem.php.

ElggRiverItem::getPostedTime

(

)

Get the time this activity was posted.

Returns

int

Definition at line 107 of file ElggRiverItem.php.

ElggRiverItem::getSubjectEntity

(

)

Get the subject of this river item.

Returns

ElggEntity

Definition at line 61 of file ElggRiverItem.php.

ElggRiverItem::getSubtype

(

)

Get the subtype of the object.

This is required for elgg_view_list_item().

Returns

string 'item'

Definition at line 140 of file ElggRiverItem.php.

ElggRiverItem::getTargetEntity

(

)

Get the target of this river item.

Returns

ElggEntity

Definition at line 79 of file ElggRiverItem.php.

ElggRiverItem::getTimePosted

(

)

Get the time this activity was posted.

Returns

int

Definition at line 117 of file ElggRiverItem.php.

ElggRiverItem::getType

(

)

Get the type of the object.

This is required for elgg_view_list_item(). All the other data types (entities, extenders, relationships) have a type/subtype.

Returns

string 'river'

Definition at line 129 of file ElggRiverItem.php.

ElggRiverItem::getView

(

)

Get the view used to display this river item.

Returns

string

Definition at line 97 of file ElggRiverItem.php.

ElggRiverItem::toObject

(

)

Get a plain old object copy for public consumption.

Returns

stdClass

Definition at line 149 of file ElggRiverItem.php.

Member Data Documentation

ElggRiverItem::$access_id

Definition at line 30 of file ElggRiverItem.php.

ElggRiverItem::$action_type

Definition at line 29 of file ElggRiverItem.php.

ElggRiverItem::$annotation_id

Definition at line 26 of file ElggRiverItem.php.

ElggRiverItem::$enabled

Definition at line 33 of file ElggRiverItem.php.

ElggRiverItem::$id

Definition at line 22 of file ElggRiverItem.php.

ElggRiverItem::$object_guid

Definition at line 24 of file ElggRiverItem.php.

ElggRiverItem::$posted

Definition at line 32 of file ElggRiverItem.php.

ElggRiverItem::$subject_guid

Definition at line 23 of file ElggRiverItem.php.

ElggRiverItem::$subtype

Definition at line 28 of file ElggRiverItem.php.

ElggRiverItem::$target_guid

Definition at line 25 of file ElggRiverItem.php.

ElggRiverItem::$type

Definition at line 27 of file ElggRiverItem.php.

ElggRiverItem::$view

Definition at line 31 of file ElggRiverItem.php.

---

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

• engine/classes/ElggRiverItem.php