ElggRelationship.php

Go to the documentation of this file.

<?php

class ElggRelationship extends \ElggData {

    public const PRIMARY_ATTR_NAMES = [
        'id',
        'guid_one',
        'relationship',
        'guid_two',
        'time_created',
    ];
    
    protected const INTEGER_ATTR_NAMES = [
        'guid_one',
        'guid_two',
        'time_created',
        'id',
    ];
    
    protected array $orig_attributes = [];
    
    public function __construct(?\stdClass $row = null) {
        $this->initializeAttributes();

        if (!empty($row)) {
            foreach ((array) $row as $key => $value) {
                if (!in_array($key, static::PRIMARY_ATTR_NAMES)) {
                    // don't set arbitrary attributes that aren't supported
                    continue;
                }
                
                if (in_array($key, static::INTEGER_ATTR_NAMES)) {
                    $value = (int) $value;
                }
                
                $this->attributes[$key] = $value;
            }
        }
    }

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

        $this->attributes['id'] = null;
        $this->attributes['guid_one'] = null;
        $this->attributes['relationship'] = null;
        $this->attributes['guid_two'] = null;
    }

    public function __set(string $name, mixed $value): void {
        if (in_array($name, static::INTEGER_ATTR_NAMES) && isset($value) && !is_int($value)) {
            // make sure the new value is an int for the int columns
            $value = (int) $value;
        }
        
        if ($this->$name === $value) {
            // nothing changed
            return;
        }
        
        if (!array_key_exists($name, $this->attributes)) {
            // only support setting attributes
            return;
        }
        
        if (in_array($name, ['id', 'time_created'])) {
            // these attributes can't be changed by the user
            return;
        }
        
        if ($this->id > 0 && !array_key_exists($name, $this->orig_attributes)) {
            // store original attribute
            $this->orig_attributes[$name] = $this->attributes[$name];
        }
        
        $this->attributes[$name] = $value;
    }

    public function __get(string $name): mixed {
        if (array_key_exists($name, $this->attributes)) {
            return $this->attributes[$name];
        }

        return null;
    }

    public function save(): bool {
        if ($this->id > 0 && empty($this->orig_attributes)) {
            // nothing has changed
            return true;
        }
        
        if ($this->id > 0) {
            _elgg_services()->relationshipsTable->delete($this->id);
        }

        $id = _elgg_services()->relationshipsTable->add($this, true);
        if ($id === false) {
            return false;
        }
        
        $this->attributes['id'] = $id;
        $this->attributes['time_created'] = _elgg_services()->relationshipsTable->getCurrentTime()->getTimestamp();

        return true;
    }

    public function delete(): bool {
        return _elgg_services()->relationshipsTable->delete($this->id);
    }

    public function getURL(): string {
        $url = _elgg_services()->events->triggerResults('relationship:url', $this->getType(), ['relationship' => $this], '');

        return elgg_normalize_url($url);
    }

    public function toObject(array $params = []) {
        $object = new \Elgg\Export\Relationship();
        $object->id = $this->id;
        $object->subject_guid = $this->guid_one;
        $object->relationship = $this->relationship;
        $object->object_guid = $this->guid_two;
        $object->time_created = date('c', $this->getTimeCreated());

        $params['relationship'] = $this;

        return _elgg_services()->events->triggerResults('to:object', 'relationship', $params, $object);
    }

    // SYSTEM LOG INTERFACE ////////////////////////////////////////////////////////////

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

    public function getObjectFromID(int $id) {
        return _elgg_services()->relationshipsTable->get($id);
    }

    public function getType(): string {
        return 'relationship';
    }

    public function getSubtype(): string {
        return $this->relationship;
    }
    
    public function getOriginalAttributes(): array {
        return $this->orig_attributes;
    }
}