ElggRiverItem.php

Go to the documentation of this file.

<?php

class ElggRiverItem {
    
    protected const INTEGER_ATTR_NAMES = [
        'id',
        'subject_guid',
        'object_guid',
        'target_guid',
        'annotation_id',
        'access_id',
        'posted',
    ];
    
    public function __construct(\stdClass $row = null) {
        if (!empty($row)) {
            // build from database
            foreach ($row as $key => $value) {
                if (in_array($key, static::INTEGER_ATTR_NAMES)) {
                    $this->$key = (int) $value;
                } else {
                    $this->$key = $value;
                }
            }
        }
    }
    
    public function __set(string $name, $value) {
        $this->$name = $value;
    }

    public function __get($name) {
        switch ($name) {
            case 'type' :
            case 'subtype' :
                $object = get_entity($this->object_guid);
                if ($object) {
                    return $object->$name;
                }
                break;
        }
    }

    public function getSubjectEntity() {
        return get_entity($this->subject_guid);
    }

    public function getObjectEntity() {
        return get_entity($this->object_guid);
    }

    public function getTargetEntity() {
        return get_entity($this->target_guid);
    }

    public function getAnnotation() {
        return elgg_get_annotation_from_id($this->annotation_id);
    }

    public function getView() {
        return $this->view;
    }

    public function getTimePosted() {
        return (int) $this->posted;
    }

    public function getType() {
        return 'river';
    }

    public function getSubtype() {
        return 'item';
    }

    public function canDelete($user_guid = 0) {
        return _elgg_services()->userCapabilities->canDeleteRiverItem($this, $user_guid);
    }

    public function delete() {
        if (!$this->canDelete()) {
            return false;
        }

        return _elgg_services()->riverTable->delete($this);
    }

    public function toObject() {
        $object = new \stdClass();
        $object->id = $this->id;
        $object->subject_guid = $this->subject_guid;
        $object->target_guid = $this->target_guid;
        $object->object_guid = $this->object_guid;
        $object->annotation_id = $this->annotation_id;
        $object->read_access = $this->access_id;
        $object->action = $this->action_type;
        $object->view = $this->view;
        $object->time_posted = date('c', $this->getTimePosted());
        
        $params = ['item' => $this];
        return _elgg_services()->hooks->trigger('to:object', 'river_item', $params, $object);
    }
    
    public function save(): bool {
        if ($this->id) {
            // update (not supported)
            return true;
        }
        
        return (bool) _elgg_services()->riverTable->create($this);
    }
}