ElggExtender.php

Go to the documentation of this file.

<?php

use Elgg\Exceptions\UnexpectedValueException as ElggUnexpectedValueException;

abstract class ElggExtender extends \ElggData {

    protected const INTEGER_ATTR_NAMES = [
        'id',
        'entity_guid',
        'owner_guid',
        'access_id',
        'time_created',
    ];

    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, static::INTEGER_ATTR_NAMES)) {
            $value = (int) $value;
        }
        
        $this->attributes[$name] = $value;
        if ($name == 'value') {
            $this->attributes['value_type'] = self::detectValueType($value);
        }
    }

    public function setValue($value, string $value_type = ''): void {
        $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 'bool':
                        return (bool) $this->attributes['value'];
                    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 ElggUnexpectedValueException($msg);
                }
            }

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

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

        return null;
    }

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

    public function getOwnerEntity(): ?\ElggEntity {
        return $this->owner_guid ? get_entity($this->owner_guid) : null;
    }

    public function getEntity(): ?\ElggEntity {
        return $this->entity_guid ? get_entity($this->entity_guid) : null;
    }

    abstract public function canEdit(int $user_guid = 0): bool;

    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->getType()] = $this;
                
        return _elgg_services()->events->triggerResults('to:object', $this->getType(), $params, $object);
    }

    /*
     * SYSTEM LOG INTERFACE
     */

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

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

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

    public function getURL(): string {

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

        return elgg_normalize_url($url);
    }

    public static function detectValueType($value, string $value_type = ''): string {
        if (in_array($value_type, ['integer', 'text', 'bool'])) {
            return $value_type;
        }

        if (is_int($value)) {
            return 'integer';
        } elseif (is_bool($value)) {
            return 'bool';
        }
        
        return 'text';
    }
}