ElggData.php

Go to the documentation of this file.

<?php
abstract class ElggData implements
    Loggable,    // Can events related to this object class be logged
    Iterator,    // Override foreach behaviour
    ArrayAccess, // Override for array access
    Exportable   // (deprecated 1.9)
{

    protected $attributes = array();

    // @codingStandardsIgnoreStart
    protected function initialise_attributes($pre18_api = true) {
        if ($pre18_api) {
            elgg_deprecated_notice('initialise_attributes() is deprecated by initializeAttributes()', 1.8);
        }
    }
    // @codingStandardsIgnoreEnd

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

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

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

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

    abstract protected function get($name);

    abstract protected function set($name, $value);

    abstract public function getURL();

    abstract public function save();

    abstract public function delete();

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

    abstract public function toObject();

    /*
     *  SYSTEM LOG INTERFACE
     */

    public function getClassName() {
        elgg_deprecated_notice("getClassName() is deprecated. Use get_class().", 1.9);
        return get_class($this);
    }

    public function getObjectOwnerGUID() {
        elgg_deprecated_notice("getObjectOwnerGUID() was deprecated.  Use getOwnerGUID().", 1.8);
        return $this->owner_guid;
    }

    /*
     * 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->attributes[$key];
        }
        return null;
    }

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

    public function offsetExists($offset) {
        return array_key_exists($offset, $this->attributes);
    }
}