ElggData.php

Go to the documentation of this file.

<?php

use Elgg\Collections\CollectionItemInterface;
use Elgg\Traits\TimeUsing;

abstract class ElggData implements CollectionItemInterface,
                                   Iterator,
                                   ArrayAccess {

    use TimeUsing;

    protected $attributes = [];

    protected function initializeAttributes() {
        $this->attributes['time_created'] = null;
    }

    protected function getDatabase(): \Elgg\Database {
        return _elgg_services()->db;
    }

    public function __isset($name) {
        return $this->$name !== null;
    }

    public function __unset($name) {
        $this->$name = null;
    }

    abstract public function getURL(): string;

    abstract public function save(): bool;

    abstract public function delete(): bool;

    public function getTimeCreated(): int {
        return (int) $this->attributes['time_created'];
    }

    abstract public function toObject(array $params = []);
    
    /*
     * SYSTEM LOG RELATED FUNCTIONS
     */
    
    abstract public function getSystemLogID(): int;
    
    abstract public function getType(): string;
    
    abstract public function getSubtype(): string;
    
    abstract public function getObjectFromID(int $id);

    protected $valid = false;

    #[\ReturnTypeWillChange]
    public function rewind() {
        $this->valid = (reset($this->attributes) !== false);
    }

    #[\ReturnTypeWillChange]
    public function current() {
        return current($this->attributes);
    }

    #[\ReturnTypeWillChange]
    public function key() {
        return key($this->attributes);
    }

    #[\ReturnTypeWillChange]
    public function next() {
        $this->valid = (next($this->attributes) !== false);
    }

    #[\ReturnTypeWillChange]
    public function valid() {
        return $this->valid;
    }

    /*
     * ARRAY ACCESS INTERFACE
     */

    #[\ReturnTypeWillChange]
    public function offsetSet($offset, $value) {
        if (array_key_exists($offset, $this->attributes)) {
            $this->attributes[$offset] = $value;
        }
    }

    #[\ReturnTypeWillChange]
    public function offsetGet($offset) {
        if (array_key_exists($offset, $this->attributes)) {
            return $this->$offset;
        }

        return null;
    }

    #[\ReturnTypeWillChange]
    public function offsetUnset($offset) {
        if (array_key_exists($offset, $this->attributes)) {
            // Full unsetting is dangerous for our objects
            unset($this->$offset);
        }
    }

    #[\ReturnTypeWillChange]
    public function offsetExists($offset) {
        return array_key_exists($offset, $this->attributes);
    }

    public function getID() {
        return $this->getSystemLogID();
    }

    public function getPriority() {
        return $this->getTimeCreated();
    }

    public function __serialize(): array {
        return $this->attributes;
    }

    public function __unserialize(array $data): void {
        $this->attributes = $data;
    }
}