ElggExtender.php

Go to the documentation of this file.

<?php
abstract class ElggExtender extends \ElggData {

    protected function initializeAttributes() {
        parent::initializeAttributes();

        $this->attributes['type'] = null;
        $this->attributes['id'] = null;
        $this->attributes['entity_guid'] = null;
        $this->attributes['owner_guid'] = null;
        $this->attributes['access_id'] = ACCESS_PRIVATE;
        $this->attributes['enabled'] = 'yes';
    }

    public function __set($name, $value) {
        if ($name === 'access_id' && $this instanceof ElggMetadata && $value != ACCESS_PUBLIC) {
            elgg_deprecated_notice('Setting ->access_id to a value other than ACCESS_PUBLIC is deprecated. '
                . 'All metadata will be public in 3.0.', '2.3');
        }

        $this->attributes[$name] = $value;
        if ($name == 'value') {
            $this->attributes['value_type'] = self::detectValueType($value);
        }
    }

    public function setValue($value, $value_type = '') {
        $this->attributes['value'] = $value;
        $this->attributes['value_type'] = self::detectValueType($value, $value_type);
    }

    protected function set($name, $value, $value_type = '') {
        elgg_deprecated_notice("Use -> instead of set()", 1.9);
        if ($name == 'value') {
            $this->setValue($value, $value_type);
        } else {
            $this->__set($name, $value);
        }

        return true;
    }

    public function __get($name) {
        if (array_key_exists($name, $this->attributes)) {
            if ($name == 'value') {
                switch ($this->attributes['value_type']) {
                    case 'integer' :
                        return (int)$this->attributes['value'];
                        break;
                    case 'text' :
                        return $this->attributes['value'];
                        break;
                    default :
                        $msg = "{$this->attributes['value_type']} is not a supported \ElggExtender value type.";
                        throw new \UnexpectedValueException($msg);
                        break;
                }
            }

            return $this->attributes[$name];
        }

        return null;
    }

    protected function get($name) {
        elgg_deprecated_notice("Use -> instead of get()", 1.9);
        return $this->__get($name);
    }

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

    public function getOwnerEntity() {
        return get_entity($this->owner_guid);
    }

    public function getEntity() {
        return get_entity($this->entity_guid);
    }

    abstract public function canEdit($user_guid = 0);

    public function toObject() {
        $object = new \stdClass();
        $object->id = $this->id;
        $object->entity_guid = $this->entity_guid;
        $object->owner_guid = $this->owner_guid;
        $object->name = $this->name;
        $object->value = $this->value;
        $object->time_created = date('c', $this->getTimeCreated());
        $object->read_access = $this->access_id;
        $params = array(
            $this->getSubtype() => $this, // deprecated use
            $this->getType() => $this,
        );
        if (_elgg_services()->hooks->hasHandler('to:object', $this->getSubtype())) {
            _elgg_services()->deprecation->sendNotice("Triggering 'to:object' hook by extender name '{$this->getSubtype()}' has been deprecated. "
            . "Use the generic 'to:object','{$this->getType()}' hook instead.", '2.3');
            $object = _elgg_services()->hooks->trigger('to:object', $this->getSubtype(), $params, $object);
        }
        return _elgg_services()->hooks->trigger('to:object', $this->getType(), $params, $object);
    }

    /*
     * EXPORTABLE INTERFACE
     */

    public function getExportableValues() {
        elgg_deprecated_notice(__METHOD__ . ' has been deprecated by toObject()', 1.9);
        return array(
            'id',
            'entity_guid',
            'name',
            'value',
            'value_type',
            'owner_guid',
            'type',
        );
    }

    public function export() {
        elgg_deprecated_notice(__METHOD__ . ' has been deprecated', 1.9);
        $uuid = get_uuid_from_object($this);

        $meta = new ODDMetaData($uuid, guid_to_uuid($this->entity_guid), $this->attributes['name'],
            $this->attributes['value'], $this->attributes['type'], guid_to_uuid($this->owner_guid));
        $meta->setAttribute('published', date("r", $this->time_created));

        return $meta;
    }

    /*
     * SYSTEM LOG INTERFACE
     */

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

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

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

    public function getURL() {

        $url = "";
        $type = $this->getType();
        $subtype = $this->getSubtype();

        // @todo remove when elgg_register_extender_url_handler() has been removed
        if ($this->id) {
            global $CONFIG;

            $function = "";
            if (isset($CONFIG->extender_url_handler[$type][$subtype])) {
                $function = $CONFIG->extender_url_handler[$type][$subtype];
            }
            if (isset($CONFIG->extender_url_handler[$type]['all'])) {
                $function = $CONFIG->extender_url_handler[$type]['all'];
            }
            if (isset($CONFIG->extender_url_handler['all']['all'])) {
                $function = $CONFIG->extender_url_handler['all']['all'];
            }
            if (is_callable($function)) {
                $url = call_user_func($function, $this);
            }

            if ($url) {
                $url = elgg_normalize_url($url);
            }
        }

        $params = array('extender' => $this);
        $url = _elgg_services()->hooks->trigger('extender:url', $type, $params, $url);

        return elgg_normalize_url($url);
    }

    public static function detectValueType($value, $value_type = "") {
        if ($value_type === 'integer' || $value_type === 'text') {
            return $value_type;
        }

        return is_int($value) ? 'integer' : 'text';
    }
}