Elgg\Database\RiverTable Class Reference

River table database action. More...

Public Member Functions
	__construct (protected Database $db, protected AnnotationsTable $annotationsTable, protected EntityTable $entityTable, protected EventsService $events, protected ViewsService $views)
	Create the river table service. More...
	get (int $id)
	Get a river item based on its ID. More...
	create (\ElggRiverItem $item)
	Save a river item to the database. More...
	delete (\ElggRiverItem $item)
	Delete a river item. More...
	updateLastAction (\ElggRiverItem $item, ?int $last_action=null)
	Update the last_action column in the river table for $item. More...

Public Attributes
const	TABLE_NAME = 'river'
const	DEFAULT_JOIN_ALIAS = 'rv'

Detailed Description

River table database action.

Since

4.0

Definition at line 16 of file RiverTable.php.

Constructor & Destructor Documentation

__construct()

Elgg\Database\RiverTable::__construct	(	protected Database	$db,
		protected AnnotationsTable	$annotationsTable,
		protected EntityTable	$entityTable,
		protected EventsService	$events,
		protected ViewsService	$views
	)

Create the river table service.

Parameters

Database	$db	database service
AnnotationsTable	$annotationsTable	annotations service
EntityTable	$entityTable	entity table service
EventsService	$events	events service
ViewsService	$views	views service

Definition at line 36 of file RiverTable.php.

Member Function Documentation

create()

Elgg\Database\RiverTable::create

(

\ElggRiverItem

$item

)

Save a river item to the database.

Parameters

\ElggRiverItem

$item

item to save

Returns

bool

Definition at line 69 of file RiverTable.php.

delete()

Elgg\Database\RiverTable::delete

(

\ElggRiverItem

$item

)

Delete a river item.

Parameters

\ElggRiverItem

$item

the item to delete

Returns

bool

Definition at line 138 of file RiverTable.php.

get()

Elgg\Database\RiverTable::get

(

int

$id

)

Get a river item based on its ID.

Parameters

int

$id

the ID of the river item

Returns

\ElggRiverItem|null

Definition at line 52 of file RiverTable.php.

updateLastAction()

Elgg\Database\RiverTable::updateLastAction	(	\ElggRiverItem	$item,
		?int	$last_action = null
	)

Update the last_action column in the river table for $item.

Parameters

\ElggRiverItem	$item	River item to update
null | int	$last_action	Timestamp of last action

Returns

int

Definition at line 165 of file RiverTable.php.

Member Data Documentation

DEFAULT_JOIN_ALIAS

const Elgg\Database\RiverTable::DEFAULT_JOIN_ALIAS = 'rv'

Definition at line 25 of file RiverTable.php.

TABLE_NAME

const Elgg\Database\RiverTable::TABLE_NAME = 'river'

Definition at line 23 of file RiverTable.php.

---

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

• engine/classes/Elgg/Database/RiverTable.php