friends.php

Go to the documentation of this file.

<?php
function _elgg_friends_init() {
    elgg_register_action('friends/add');
    elgg_register_action('friends/remove');

    elgg_register_action('friends/collections/add');
    elgg_register_action('friends/collections/delete');
    elgg_register_action('friends/collections/edit');

    elgg_register_page_handler('friends', '_elgg_friends_page_handler');
    elgg_register_page_handler('friendsof', '_elgg_friends_page_handler');
    elgg_register_page_handler('collections', '_elgg_collections_page_handler');

    elgg_register_widget_type('friends', elgg_echo('friends'), elgg_echo('friends:widget:description'));

    elgg_register_event_handler('pagesetup', 'system', '_elgg_friends_page_setup');
    elgg_register_event_handler('pagesetup', 'system', '_elgg_setup_collections_menu');
    elgg_register_plugin_hook_handler('register', 'menu:user_hover', '_elgg_friends_setup_user_hover_menu');
    elgg_register_event_handler('create', 'relationship', '_elgg_send_friend_notification');
}

function _elgg_friends_page_setup() {
    $owner = elgg_get_page_owner_entity();
    $viewer = elgg_get_logged_in_user_entity();

    if ($owner) {
        $params = array(
            'name' => 'friends',
            'text' => elgg_echo('friends'),
            'href' => 'friends/' . $owner->username,
            'contexts' => array('friends')
        );
        elgg_register_menu_item('page', $params);

        $params = array(
            'name' => 'friends:of',
            'text' => elgg_echo('friends:of'),
            'href' => 'friendsof/' . $owner->username,
            'contexts' => array('friends')
        );
        elgg_register_menu_item('page', $params);
    }

    // topbar
    if ($viewer) {
        elgg_register_menu_item('topbar', array(
            'name' => 'friends',
            'href' => "friends/{$viewer->username}",
            'text' => elgg_view_icon('users'),
            'title' => elgg_echo('friends'),
            'priority' => 300,
        ));
    }
}

function _elgg_friends_setup_user_hover_menu($hook, $type, $return, $params) {
    $user = $params['entity'];
    /* @var \ElggUser $user */

    if (elgg_is_logged_in()) {
        if (elgg_get_logged_in_user_guid() != $user->guid) {
            $isFriend = $user->isFriend();

            // Always emit both to make it super easy to toggle with ajax
            $return[] = \ElggMenuItem::factory(array(
                'name' => 'remove_friend',
                'href' => elgg_add_action_tokens_to_url("action/friends/remove?friend={$user->guid}"),
                'text' => elgg_echo('friend:remove'),
                'section' => 'action',
                'item_class' => $isFriend ? '' : 'hidden',
            ));

            $return[] = \ElggMenuItem::factory(array(
                'name' => 'add_friend',
                'href' => elgg_add_action_tokens_to_url("action/friends/add?friend={$user->guid}"),
                'text' => elgg_echo('friend:add'),
                'section' => 'action',
                'item_class' => $isFriend ? 'hidden' : '',
            ));
        }
    }

    return $return;
}

function _elgg_friends_page_handler($segments, $handler) {
    elgg_set_context('friends');

    if (isset($segments[0]) && $user = get_user_by_username($segments[0])) {
        elgg_set_page_owner_guid($user->getGUID());
    }

    if (!elgg_get_page_owner_guid()) {
        return false;
    }

    switch ($handler) {
        case 'friends':
            echo elgg_view_resource("friends/index");
            break;
        case 'friendsof':
            echo elgg_view_resource("friends/of");
            break;
        default:
            return false;
    }
    return true;
}

function _elgg_collections_page_handler($page_elements) {
    elgg_set_context('friends');
    if (isset($page_elements[0])) {
        switch ($page_elements[0]) {
            case 'add':
                elgg_set_page_owner_guid(elgg_get_logged_in_user_guid());
                
                echo elgg_view_resource("friends/collections/add");
                return true;
            case 'owner':
                $user = get_user_by_username($page_elements[1]);
                if ($user) {
                    elgg_set_page_owner_guid($user->getGUID());
                    
                    echo elgg_view_resource("friends/collections/view");
                    return true;
                }
                break;
            case 'pickercallback':
                echo elgg_view_resource('friends/collections/pickercallback');
                return true;
        }
    }
    return false;
}

function _elgg_setup_collections_menu() {
    
    if (elgg_is_logged_in() && elgg_get_logged_in_user_guid() == elgg_get_page_owner_guid()) {
        $user = elgg_get_page_owner_entity();
        
        elgg_register_menu_item('page', array(
            'name' => 'friends:view:collections',
            'text' => elgg_echo('friends:collections'),
            'href' => "collections/owner/$user->username",
            'contexts' => array('friends')
        ));
    }
}

function _elgg_send_friend_notification($event, $type, $object) {
    if ($object->relationship != 'friend') {
        return true;
    }
    
    $user_one = get_entity($object->guid_one);
    /* @var \ElggUser $user_one */

    $user_two = get_entity($object->guid_two);
    /* @var ElggUser $user_two */

    // Notification subject
    $subject = elgg_echo('friend:newfriend:subject', array(
        $user_one->name
    ), $user_two->language);

    // Notification body
    $body = elgg_echo("friend:newfriend:body", array(
        $user_one->name,
        $user_one->getURL()
    ), $user_two->language);

    // Notification params
    $params = [
        'action' => 'add_friend',
        'object' => $user_one,
    ];
    
    return notify_user($user_two->guid, $object->guid_one, $subject, $body, $params);
}

return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
    $events->registerHandler('init', 'system', '_elgg_friends_init');
};