Elgg  Version 3.0
Public Member Functions | Public Attributes | List of all members
ElggRiverItem Class Reference

Public Member Functions

 __construct ($object)
 Construct a river item object given a database row. More...
 
 __get ($name)
 {} 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...
 
 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...
 
 canDelete ($user_guid=0)
 Can a user delete this river item? More...
 
 delete ()
 Delete the river item. More...
 
 toObject ()
 Get a plain old object copy for public consumption. More...
 

Public Attributes

 $id
 
 $subject_guid
 
 $object_guid
 
 $target_guid
 
 $annotation_id
 
 $action_type
 
 $access_id
 
 $view
 
 $posted
 
 $enabled
 

Detailed Description

Definition at line 22 of file ElggRiverItem.php.

Constructor & Destructor Documentation

ElggRiverItem::__construct (   $object)

Construct a river item object given a database row.

Parameters
\stdClass$objectObject obtained from database

Definition at line 39 of file ElggRiverItem.php.

Member Function Documentation

ElggRiverItem::__get (   $name)

{}

Definition at line 58 of file ElggRiverItem.php.

ElggRiverItem::canDelete (   $user_guid = 0)

Can a user delete this river item?

Can be overridden by registering for the "permissions_check:delete", "river" plugin hook.

Parameters
int$user_guidThe user GUID, optionally (default: logged in user)
Returns
bool Whether this river item should be considered deletable by the given user.
Since
2.3

Definition at line 157 of file ElggRiverItem.php.

ElggRiverItem::delete ( )

Delete the river item.

Returns
bool False if the user lacks permission or the before event is cancelled
Since
2.3

Definition at line 167 of file ElggRiverItem.php.

ElggRiverItem::getAnnotation ( )

Get the Annotation for this river item.

Returns
|false

Definition at line 102 of file ElggRiverItem.php.

ElggRiverItem::getObjectEntity ( )

Get the object of this river item.

Returns

Definition at line 84 of file ElggRiverItem.php.

ElggRiverItem::getSubjectEntity ( )

Get the subject of this river item.

Returns

Definition at line 75 of file ElggRiverItem.php.

ElggRiverItem::getSubtype ( )

Get the subtype of the object.

This is required for elgg_view_list_item().

Returns
string 'item'
Examples:
/root/Elgg/engine/lib/views.php.

Definition at line 143 of file ElggRiverItem.php.

ElggRiverItem::getTargetEntity ( )

Get the target of this river item.

Returns

Definition at line 93 of file ElggRiverItem.php.

ElggRiverItem::getTimePosted ( )

Get the time this activity was posted.

Returns
int

Definition at line 120 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'
Examples:
/root/Elgg/engine/lib/views.php.

Definition at line 132 of file ElggRiverItem.php.

ElggRiverItem::getView ( )

Get the view used to display this river item.

Returns
string

Definition at line 111 of file ElggRiverItem.php.

ElggRiverItem::toObject ( )

Get a plain old object copy for public consumption.

Returns

Definition at line 191 of file ElggRiverItem.php.

Member Data Documentation

ElggRiverItem::$access_id

Definition at line 29 of file ElggRiverItem.php.

ElggRiverItem::$action_type

Definition at line 28 of file ElggRiverItem.php.

ElggRiverItem::$annotation_id

Definition at line 27 of file ElggRiverItem.php.

ElggRiverItem::$enabled

Definition at line 32 of file ElggRiverItem.php.

ElggRiverItem::$id

Definition at line 23 of file ElggRiverItem.php.

ElggRiverItem::$object_guid

Definition at line 25 of file ElggRiverItem.php.

ElggRiverItem::$posted

Definition at line 31 of file ElggRiverItem.php.

ElggRiverItem::$subject_guid

Definition at line 24 of file ElggRiverItem.php.

ElggRiverItem::$target_guid

Definition at line 26 of file ElggRiverItem.php.

ElggRiverItem::$view

Definition at line 30 of file ElggRiverItem.php.


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