ElggRelationship.php

Go to the documentation of this file.

<?php
class ElggRelationship extends \ElggData implements
    Importable // deprecated
{
    // database column limit
    const RELATIONSHIP_LIMIT = 50;

    public function __construct($row = null) {
        $this->initializeAttributes();

        if ($row === null) {
            elgg_deprecated_notice('Passing null to constructor is deprecated. Use add_entity_relationship()', 1.9);
            return;
        }

        if (!($row instanceof \stdClass)) {
            if (!is_numeric($row)) {
                throw new \InvalidArgumentException("Constructor accepts only a \stdClass or null.");
            }

            $id = (int)$row;
            elgg_deprecated_notice('Passing an ID to constructor is deprecated. Use get_relationship()', 1.9);
            $row = _elgg_services()->relationshipsTable->getRow($id);
            if (!$row) {
                throw new \InvalidArgumentException("Relationship not found with ID $id");
            }
        }

        foreach ((array)$row as $key => $value) {
            $this->attributes[$key] = $value;
        }

        $this->attributes['id'] = (int)$this->attributes['id'];
    }

    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($name, $value) {
        $this->attributes[$name] = $value;
    }

    public function set($name, $value) {
        elgg_deprecated_notice("Use -> instead of set()", 1.9);
        $this->__set($name, $value);
        return true;
    }

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

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

    public function save() {
        if ($this->id > 0) {
            delete_relationship($this->id);
        }

        $this->id = _elgg_services()->relationshipsTable->add(
            $this->guid_one,
            $this->relationship,
            $this->guid_two,
            true
        );
        if (!$this->id) {
            throw new \IOException("Unable to save new " . get_class());
        }

        return $this->id;
    }

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

    public function getURL() {
        $url = '';
        // @todo remove when elgg_register_relationship_url_handler() has been removed
        if ($this->id) {
            global $CONFIG;

            $subtype = $this->getSubtype();

            $function = "";
            if (isset($CONFIG->relationship_url_handler[$subtype])) {
                $function = $CONFIG->relationship_url_handler[$subtype];
            }
            if (isset($CONFIG->relationship_url_handler['all'])) {
                $function = $CONFIG->relationship_url_handler['all'];
            }

            if (is_callable($function)) {
                $url = call_user_func($function, $this);
            }

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

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

        return elgg_normalize_url($url);
    }

    public function toObject() {
        $object = new \stdClass();
        $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 = array('relationship' => $this);
        return _elgg_services()->hooks->trigger('to:object', 'relationship', $params, $object);
    }

    // EXPORTABLE INTERFACE ////////////////////////////////////////////////////////////

    public function getExportableValues() {
        elgg_deprecated_notice(__METHOD__ . ' has been deprecated by toObject()', 1.9);
        return array(
            'id',
            'guid_one',
            'relationship',
            'guid_two'
        );
    }

    public function export() {
        elgg_deprecated_notice(__METHOD__ . ' has been deprecated', 1.9);
        $uuid = get_uuid_from_object($this);
        $relationship = new ODDRelationship(
            guid_to_uuid($this->guid_one),
            $this->relationship,
            guid_to_uuid($this->guid_two)
        );

        $relationship->setAttribute('uuid', $uuid);

        return $relationship;
    }

    // IMPORTABLE INTERFACE ////////////////////////////////////////////////////////////

    public function import(ODD $data) {
        elgg_deprecated_notice(__METHOD__ . ' has been deprecated', 1.9);
        if (!($data instanceof ODDRelationship)) {
            throw new \InvalidParameterException("import() passed an unexpected ODD class");
        }

        $uuid_one = $data->getAttribute('uuid1');
        $uuid_two = $data->getAttribute('uuid2');

        // See if this entity has already been imported, if so then we need to link to it
        $entity1 = get_entity_from_uuid($uuid_one);
        $entity2 = get_entity_from_uuid($uuid_two);
        if (($entity1) && ($entity2)) {
            // Set the item ID
            $this->attributes['guid_one'] = $entity1->getGUID();
            $this->attributes['guid_two'] = $entity2->getGUID();

            // Map verb to relationship
            //$verb = $data->getAttribute('verb');
            //$relationship = get_relationship_from_verb($verb);
            $relationship = $data->getAttribute('type');

            if ($relationship) {
                $this->attributes['relationship'] = $relationship;
                // save
                $result = $this->save();
                if (!$result) {
                    throw new \ImportException("There was a problem saving " . get_class());
                }

                return true;
            }
        }

        return false;
    }

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

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

    public function getObjectFromID($id) {
        return get_relationship($id);
    }

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

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