Friends.php

Go to the documentation of this file.

<?php

namespace Elgg\Traits\Entity;

trait Friends {
    
    public function addFriend(int $friend_guid, bool $create_river_item = false) {
        if (!get_user($friend_guid)) {
            return false;
        }

        if (!$this->addRelationship($friend_guid, 'friend')) {
            return false;
        }

        if ($create_river_item) {
            elgg_create_river_item([
                'view' => 'river/relationship/friend/create',
                'action_type' => 'friend',
                'subject_guid' => $this->guid,
                'object_guid' => $friend_guid,
            ]);
        }

        return true;
    }

    public function removeFriend(int $friend_guid): bool {
        return $this->removeRelationship($friend_guid, 'friend');
    }

    public function isFriend(): bool {
        elgg_deprecated_notice(__CLASS__ . '->' . __FUNCTION__ . '() has been deprecated. Use ' . __CLASS__ . '->isFriendOf()', '4.3');

        return $this->isFriendOf(_elgg_services()->session->getLoggedInUserGuid());
    }

    public function isFriendsWith(int $user_guid): bool {
        return $this->hasRelationship($user_guid, 'friend');
    }

    public function isFriendOf(int $user_guid): bool {
        return (bool) _elgg_services()->relationshipsTable->check($user_guid, 'friend', $this->guid);
    }

    public function getFriends(array $options = []) {
        elgg_deprecated_notice(__CLASS__ . '->' . __FUNCTION__ . '() has been deprecated. Use ' . __CLASS__ . '->getEntitiesFromRelationship()', '4.3');

        $options['relationship'] = 'friend';
        $options['relationship_guid'] = $this->guid;
        $options['type'] = 'user';

        return elgg_get_entities($options);
    }

    public function getFriendsOf(array $options = []) {
        elgg_deprecated_notice(__CLASS__ . '->' . __FUNCTION__ . '() has been deprecated. Use ' . __CLASS__ . '->getEntitiesFromRelationship()', '4.3');

        $options['relationship'] = 'friend';
        $options['relationship_guid'] = $this->guid;
        $options['inverse_relationship'] = true;
        $options['type'] = 'user';

        return elgg_get_entities($options);
    }
    
    public function getFriendsObjects(array $options = []) {
        elgg_deprecated_notice(__CLASS__ . '->' . __FUNCTION__ . '() has been deprecated. Use ' . __CLASS__ . '->getEntitiesFromRelationship()', '4.3');

        $options['type'] = 'object';
        $options['relationship'] = 'friend';
        $options['relationship_guid'] = $this->guid;
        $options['relationship_join_on'] = 'container_guid';

        return elgg_get_entities($options);
    }
}