ElggData.php

Go to the documentation of this file.

<?php

use Elgg\Collections\CollectionItemInterface;

abstract class ElggData implements CollectionItemInterface,
                                   Serializable,
                                   Loggable,
                                   Iterator,
                                   ArrayAccess {

    use \Elgg\TimeUsing;

    protected $attributes = [];

    protected function initializeAttributes() {
        // Create attributes array if not already created
        if (!is_array($this->attributes)) {
            $this->attributes = [];
        }

        $this->attributes['time_created'] = null;
    }

    protected function getDatabase() {
        return _elgg_services()->db;
    }

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

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

    abstract public function getURL();

    abstract public function save();

    abstract public function delete();

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

    abstract public function toObject(array $params = []);

    /*
     * ITERATOR INTERFACE
     */

    protected $valid = false;

    public function rewind() {
        $this->valid = (false !== reset($this->attributes));
    }

    public function current() {
        return current($this->attributes);
    }

    public function key() {
        return key($this->attributes);
    }

    public function next() {
        $this->valid = (false !== next($this->attributes));
    }

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

    /*
     * ARRAY ACCESS INTERFACE
     */

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

    public function offsetGet($key) {
        if (array_key_exists($key, $this->attributes)) {
            return $this->$key;
        }

        return null;
    }

    public function offsetUnset($key) {
        if (array_key_exists($key, $this->attributes)) {
            // Full unsetting is dangerous for our objects
            unset($this->$key);
        }
    }

    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() {
        return serialize($this->attributes);
    }

    public function unserialize($serialized) {
        $this->attributes = unserialize($serialized);
    }
}