ElggRiverItem.php

Go to the documentation of this file.

<?php
 
use Elgg\Exceptions\RuntimeException as ElggRuntimeException;
 
class ElggRiverItem {
    
    protected const INTEGER_ATTR_NAMES = [
        'id',
        'subject_guid',
        'object_guid',
        'target_guid',
        'annotation_id',
        'access_id',
        'posted',
        'last_action',
    ];
    
    protected array $attributes = [];
    
    public function __construct(?\stdClass $row = null) {
        $this->initializeAttributes();
        
        if (empty($row)) {
            return;
        }
        
        // build from database
        foreach ($row as $key => $value) {
            if (!array_key_exists($key, $this->attributes)) {
                continue;
            }
            
            if (in_array($key, static::INTEGER_ATTR_NAMES)) {
                $value = (int) $value;
            }
            
            $this->attributes[$key] = $value;
        }
    }
    
    public function __set(string $name, $value) {
        if (!array_key_exists($name, $this->attributes)) {
            throw new ElggRuntimeException("It's not allowed to set {$name} on " . get_class($this));
        }
        
        if (in_array($name, static::INTEGER_ATTR_NAMES)) {
            $value = (int) $value;
        }
        
        $this->attributes[$name] = $value;
    }
 
    public function __get($name) {
        switch ($name) {
            case 'type':
            case 'subtype':
                $object = $this->getObjectEntity();
                if ($object) {
                    return $object->$name;
                }
                break;
            default:
                if (array_key_exists($name, $this->attributes)) {
                    return $this->attributes[$name];
                }
                break;
        }
    }
    
    public function __isset($name) : bool {
        return isset($this->attributes[$name]);
    }
    
    public function __unset($name): void {
        if (!array_key_exists($name, $this->attributes)) {
            return;
        }
        
        $this->attributes[$name] = null;
    }
    
    protected function initializeAttributes(): void {
        $this->attributes['id'] = null;
        $this->attributes['action_type'] = null;
        $this->attributes['view'] = null;
        $this->attributes['subject_guid'] = null;
        $this->attributes['object_guid'] = null;
        $this->attributes['target_guid'] = null;
        $this->attributes['annotation_id'] = null;
        $this->attributes['posted'] = null;
        $this->attributes['last_action'] = null;
    }
 
    public function getSubjectEntity(): ?\ElggEntity {
        return $this->subject_guid ? get_entity($this->subject_guid) : null;
    }
 
    public function getObjectEntity(): ?\ElggEntity {
        return $this->object_guid ? get_entity($this->object_guid) : null;
    }
 
    public function getTargetEntity(): ?\ElggEntity {
        return $this->target_guid ? get_entity($this->target_guid) : null;
    }
 
    public function getAnnotation(): ?\ElggAnnotation {
        return $this->annotation_id ? elgg_get_annotation_from_id($this->annotation_id) : null;
    }
 
    public function getView(): string {
        return (string) $this->view;
    }
 
    public function getTimePosted(): int {
        return (int) $this->posted;
    }
 
    public function updateLastAction(?int $last_action = null): int {
        $this->last_action = _elgg_services()->riverTable->updateLastAction($this, $last_action);
 
        return $this->last_action;
    }
 
    public function getType(): string {
        return 'river';
    }
 
    public function getSubtype(): string {
        return 'item';
    }
 
    public function canDelete(int $user_guid = 0): bool {
        return _elgg_services()->userCapabilities->canDeleteRiverItem($this, $user_guid);
    }
 
    public function delete(): bool {
        if (!$this->canDelete()) {
            return false;
        }
 
        return _elgg_services()->riverTable->delete($this);
    }
 
    public function toObject(): \stdClass {
        $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->action = $this->action_type;
        $object->view = $this->view;
        $object->time_posted = date('c', $this->getTimePosted());
        $object->last_action = date('c', $this->last_action);
        
        $params = ['item' => $this];
        return _elgg_services()->events->triggerResults('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);
    }
}