Relationships.php

Go to the documentation of this file.

<?php

namespace Elgg\Traits\Entity;

trait Relationships {
    
    public function addRelationship(int $guid_two, string $relationship): bool {
        $rel = new \ElggRelationship();
        $rel->guid_one = $this->guid;
        $rel->relationship = $relationship;
        $rel->guid_two = $guid_two;
        
        return $rel->save();
    }
    
    public function hasRelationship(int $guid_two, string $relationship): bool {
        return (bool) _elgg_services()->relationshipsTable->check($this->guid, $relationship, $guid_two);
    }
    
    public function getRelationship(int $guid_two, string $relationship): ?\ElggRelationship {
        return _elgg_services()->relationshipsTable->check($this->guid, $relationship, $guid_two) ?: null;
    }
    
    public function getEntitiesFromRelationship(array $options = []) {
        $options['relationship_guid'] = $this->guid;
        return elgg_get_entities($options);
    }
    
    public function countEntitiesFromRelationship(string $relationship, bool $inverse_relationship = false): int {
        return elgg_count_entities([
            'relationship' => $relationship,
            'relationship_guid' => $this->guid,
            'inverse_relationship' => $inverse_relationship,
        ]);
    }
    
    public function removeRelationship(int $guid_two, string $relationship): bool {
        return _elgg_services()->relationshipsTable->remove($this->guid, $relationship, $guid_two);
    }
    
    public function removeAllRelationships(string $relationship = '', bool $inverse_relationship = false): bool {
        return _elgg_services()->relationshipsTable->removeAll($this->guid, $relationship, $inverse_relationship);
    }
}