ElggRiverItem.php

Go to the documentation of this file.

<?php

class ElggRiverItem {
    public $id;
    public $subject_guid;
    public $object_guid;
    public $target_guid;
    public $annotation_id;
    public $type;
    public $subtype;
    public $action_type;
    public $access_id;
    public $view;
    public $posted;
    public $enabled;

    public function __construct($object) {
        if (!($object instanceof \stdClass)) {
            throw new \InvalidParameterException("Invalid input to \ElggRiverItem constructor");
        }

        // the casting is to support typed serialization like json
        $int_types = array('id', 'subject_guid', 'object_guid', 'target_guid', 'annotation_id', 'access_id', 'posted');
        foreach ($object as $key => $value) {
            if (in_array($key, $int_types)) {
                $this->$key = (int)$value;
            } else {
                $this->$key = $value;
            }
        }
    }

    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 getPostedTime() {
        elgg_deprecated_notice("\ElggRiverItem::getPostedTime() deprecated in favor of getTimePosted()", 1.9);
        return (int)$this->posted;
    }

    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;
        }

        $events = _elgg_services()->events;
        if (!$events->triggerBefore('delete', 'river', $this)) {
            return false;
        }

        $db = _elgg_services()->db;
        $prefix = $db->prefix;
        _elgg_services()->db->deleteData("DELETE FROM {$prefix}river WHERE id = ?", [$this->id]);

        $events->triggerAfter('delete', 'river', $this);

        return true;
    }

    public function toObject() {
        $object = new \stdClass();
        $object->id = $this->id;
        $object->subject_guid = $this->subject_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->time_posted = date('c', $this->getTimePosted());
        $object->enabled = $this->enabled;
        $params = array('item' => $this);
        return _elgg_services()->hooks->trigger('to:object', 'river_item', $params, $object);
    }

}