ElggExtender.php

Go to the documentation of this file.

<?php
abstract class ElggExtender extends \ElggData {

    protected $int_columns = [
        'id',
        'entity_guid',
        'owner_guid',
        'time_created',
        'access_id',
    ];

    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;
        }
        if (isset($value) && in_array($name, $this->int_columns)) {
            $value = (int) $value;
        }
        $this->attributes[$name] = $value;
        if ($name == 'value') {
            if (is_bool($value)) {
                $value = (int) $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);
    }

    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'];
                    case 'text' :
                        return $this->attributes['value'];
                    default :
                        $msg = "{$this->attributes['value_type']} is not a supported \ElggExtender value type.";
                        throw new \UnexpectedValueException($msg);
                        break;
                }
            }

            if ($name === 'access_id' && $this instanceof ElggMetadata) {
                return ACCESS_PUBLIC;
            }

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

        return null;
    }

    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(array $params = []) {

        $object = new \Elgg\Export\Extender();
        $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[$this->getSubtype()] = $this; // deprecated use
        $params[$this->getType()] = $this;
        
        // deprecated toObject hook
        $deprecated_msg = "Triggering 'to:object' hook by extender name '{$this->getSubtype()}' has been deprecated. "
            . "Use the generic 'to:object','{$this->getType()}' hook instead.";
        $object = _elgg_services()->hooks->triggerDeprecated('to:object', $this->getSubtype(), $params, $object, $deprecated_msg, '2.3');
        
        return _elgg_services()->hooks->trigger('to:object', $this->getType(), $params, $object);
    }

    /*
     * SYSTEM LOG INTERFACE
     */

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

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

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

    public function getURL() {

        $params = ['extender' => $this];
        $url = _elgg_services()->hooks->trigger('extender:url', $this->getType(), $params, '');

        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';
    }
}