RiverTable.php

Go to the documentation of this file.

<?php
 
namespace Elgg\Database;
 
use Elgg\Database;
use Elgg\EventsService;
use Elgg\Traits\TimeUsing;
use Elgg\ViewsService;
 
class RiverTable {
    
    use TimeUsing;
    
    public const TABLE_NAME = 'river';
    
    public const DEFAULT_JOIN_ALIAS = 'rv';
    
    public function __construct(
        protected Database $db,
        protected AnnotationsTable $annotationsTable,
        protected EntityTable $entityTable,
        protected EventsService $events,
        protected ViewsService $views
    ) {
    }
    
    public function get(int $id): ?\ElggRiverItem {
        $select = Select::fromTable(self::TABLE_NAME);
        $select->select('*')
            ->where($select->compare('id', '=', $id, ELGG_VALUE_ID));
        
        $row = $this->db->getDataRow($select);
        
        return $row ? new \ElggRiverItem($row) : null;
    }
    
    public function create(\ElggRiverItem $item): bool {
        if ($item->id) {
            // already created
            return false;
        }
        
        if (!empty($item->view) && !$this->views->viewExists($item->view)) {
            return false;
        }
        
        if (empty($item->action_type)) {
            return false;
        }
        
        if (empty($item->subject_guid) || !$this->entityTable->exists($item->subject_guid)) {
            return false;
        }
        
        if (empty($item->object_guid) || !$this->entityTable->exists($item->object_guid)) {
            return false;
        }
        
        if (!empty($item->target_guid) && !$this->entityTable->exists($item->target_guid)) {
            return false;
        }
        
        if (!empty($item->annotation_id) && !$this->annotationsTable->get($item->annotation_id)) {
            return false;
        }
        
        $created = $item->posted ?: $this->getCurrentTime()->getTimestamp();
        
        if (!$this->events->triggerBefore('create', 'river', $item)) {
            return false;
        }
        
        $insert = Insert::intoTable(self::TABLE_NAME);
        $insert->values([
            'action_type' => $insert->param($item->action_type, ELGG_VALUE_STRING),
            'view' => $insert->param($item->view ?? '', ELGG_VALUE_STRING),
            'subject_guid' => $insert->param($item->subject_guid, ELGG_VALUE_GUID),
            'object_guid' => $insert->param($item->object_guid, ELGG_VALUE_GUID),
            'target_guid' => $insert->param($item->target_guid ?? 0, ELGG_VALUE_GUID),
            'annotation_id' => $insert->param($item->annotation_id ?? 0, ELGG_VALUE_ID),
            'posted' => $insert->param($created, ELGG_VALUE_TIMESTAMP),
            'last_action' => $insert->param($created, ELGG_VALUE_TIMESTAMP),
        ]);
        
        $id = $this->db->insertData($insert);
        if (empty($id)) {
            return false;
        }
        
        $item->id = $id;
        $item->posted = $created;
        $item->last_action = $created;
        
        $this->events->triggerAfter('create', 'river', $item);
        
        return true;
    }
    
    public function delete(\ElggRiverItem $item): bool {
        if (!$item->id) {
            return false;
        }
        
        if (!$this->events->triggerBefore('delete', 'river', $item)) {
            return false;
        }
        
        $delete = Delete::fromTable(self::TABLE_NAME);
        $delete->where($delete->compare('id', '=', $item->id, ELGG_VALUE_ID));
        
        $result = (bool) $this->db->deleteData($delete);
        
        $this->events->triggerAfter('delete', 'river', $item);
        
        return $result;
    }
    
    public function updateLastAction(\ElggRiverItem $item, ?int $last_action = null): int {
        if ($last_action === null) {
            $last_action = $this->getCurrentTime()->getTimestamp();
        }
        
        $update = Update::table(self::TABLE_NAME);
        $update->set('last_action', $update->param($last_action, ELGG_VALUE_TIMESTAMP))
            ->where($update->compare('id', '=', $item->id, ELGG_VALUE_ID));
        
        $this->db->updateData($update);
        
        return (int) $last_action;
    }
}