input.php

Go to the documentation of this file.

<?php
function get_input($variable, $default = null, $filter_result = true) {
    return _elgg_services()->input->get($variable, $default, $filter_result);
}

function set_input($variable, $value) {
    _elgg_services()->input->set($variable, $value);
}

function filter_tags($var) {
    return elgg_trigger_plugin_hook('validate', 'input', null, $var);
}

function current_page_url() {
    $url = parse_url(elgg_get_site_url());

    $page = $url['scheme'] . "://" . $url['host'];

    if (isset($url['port']) && $url['port']) {
        $page .= ":" . $url['port'];
    }

    $page = trim($page, "/");

    $page .= _elgg_services()->request->getRequestUri();

    return $page;
}

function is_email_address($address) {
    return filter_var($address, FILTER_VALIDATE_EMAIL) === $address;
}

function elgg_make_sticky_form($form_name) {
    _elgg_services()->stickyForms->makeStickyForm($form_name);
}

function elgg_clear_sticky_form($form_name) {
    _elgg_services()->stickyForms->clearStickyForm($form_name);
}

function elgg_is_sticky_form($form_name) {
    return _elgg_services()->stickyForms->isStickyForm($form_name);
}

function elgg_get_sticky_value($form_name, $variable = '', $default = null, $filter_result = true) {
    return _elgg_services()->stickyForms->getStickyValue($form_name, $variable, $default, $filter_result);
}

function elgg_get_sticky_values($form_name, $filter_result = true) {
    return _elgg_services()->stickyForms->getStickyValues($form_name, $filter_result);
}

function elgg_clear_sticky_value($form_name, $variable) {
    _elgg_services()->stickyForms->clearStickyValue($form_name, $variable);
}

function input_livesearch_page_handler($page) {
    $dbprefix = elgg_get_config('dbprefix');

    // only return results to logged in users.
    if (!$user = elgg_get_logged_in_user_entity()) {
        exit;
    }

    if (!$q = get_input('term', get_input('q'))) {
        exit;
    }

    $input_name = get_input('name', 'members');

    $q = sanitise_string($q);

    // replace mysql vars with escaped strings
    $q = str_replace(array('_', '%'), array('\_', '\%'), $q);

    $match_on = get_input('match_on', 'all');

    if (!is_array($match_on)) {
        $match_on = array($match_on);
    }

    // all = users and groups
    if (in_array('all', $match_on)) {
        $match_on = array('users', 'groups');
    }

    $owner_guid = ELGG_ENTITIES_ANY_VALUE;
    if (get_input('match_owner', false)) {
        $owner_guid = $user->getGUID();
    }

    $limit = sanitise_int(get_input('limit', elgg_get_config('default_limit')));

    // grab a list of entities and send them in json.
    $results = array();
    foreach ($match_on as $match_type) {
        switch ($match_type) {
            case 'users':
                $options = array(
                    'type' => 'user',
                    'limit' => $limit,
                    'joins' => array("JOIN {$dbprefix}users_entity ue ON e.guid = ue.guid"),
                    'wheres' => array(
                        "ue.banned = 'no'",
                        "(ue.name LIKE '$q%' OR ue.name LIKE '% $q%' OR ue.username LIKE '$q%')"
                    )
                );
                
                $entities = elgg_get_entities($options);
                if (!empty($entities)) {
                    foreach ($entities as $entity) {
                        
                        if (in_array('groups', $match_on)) {
                            $value = $entity->guid;
                        } else {
                            $value = $entity->username;
                        }

                        $output = elgg_view_list_item($entity, array(
                            'use_hover' => false,
                            'use_link' => false,
                            'class' => 'elgg-autocomplete-item',
                            'title' => $entity->name, // Default title would be a link
                        ));

                        $icon = elgg_view_entity_icon($entity, 'tiny', array(
                            'use_hover' => false,
                        ));

                        $result = array(
                            'type' => 'user',
                            'name' => $entity->name,
                            'desc' => $entity->username,
                            'guid' => $entity->guid,
                            'label' => $output,
                            'value' => $value,
                            'icon' => $icon,
                            'url' => $entity->getURL(),
                            'html' => elgg_view('input/userpicker/item', array(
                                'entity' => $entity,
                                'input_name' => $input_name,
                            )),
                        );
                        $results[$entity->name . rand(1, 100)] = $result;
                    }
                }
                break;

            case 'groups':
                // don't return results if groups aren't enabled.
                if (!elgg_is_active_plugin('groups')) {
                    break;
                }
                
                $options = array(
                    'type' => 'group',
                    'limit' => $limit,
                    'owner_guid' => $owner_guid,
                    'joins' => array("JOIN {$dbprefix}groups_entity ge ON e.guid = ge.guid"),
                    'wheres' => array(
                        "(ge.name LIKE '$q%' OR ge.name LIKE '% $q%' OR ge.description LIKE '% $q%')"
                    )
                );
                
                $entities = elgg_get_entities($options);
                if (!empty($entities)) {
                    foreach ($entities as $entity) {
                        $output = elgg_view_list_item($entity, array(
                            'use_hover' => false,
                            'class' => 'elgg-autocomplete-item',
                            'full_view' => false,
                            'href' => false,
                            'title' => $entity->name, // Default title would be a link
                        ));

                        $icon = elgg_view_entity_icon($entity, 'tiny', array(
                            'use_hover' => false,
                        ));

                        $result = array(
                            'type' => 'group',
                            'name' => $entity->name,
                            'desc' => strip_tags($entity->description),
                            'guid' => $entity->guid,
                            'label' => $output,
                            'value' => $entity->guid,
                            'icon' => $icon,
                            'url' => $entity->getURL(),
                        );

                        $results[$entity->name . rand(1, 100)] = $result;
                    }
                }
                break;

            case 'friends':
                $options = array(
                    'type' => 'user',
                    'limit' => $limit,
                    'relationship' => 'friend',
                    'relationship_guid' => $user->getGUID(),
                    'joins' => array("JOIN {$dbprefix}users_entity ue ON e.guid = ue.guid"),
                    'wheres' => array(
                        "ue.banned = 'no'",
                        "(ue.name LIKE '$q%' OR ue.name LIKE '% $q%' OR ue.username LIKE '$q%')"
                    )
                );
                
                $entities = elgg_get_entities_from_relationship($options);
                if (!empty($entities)) {
                    foreach ($entities as $entity) {
                        
                        $output = elgg_view_list_item($entity, array(
                            'use_hover' => false,
                            'use_link' => false,
                            'class' => 'elgg-autocomplete-item',
                            'title' => $entity->name, // Default title would be a link
                        ));

                        $icon = elgg_view_entity_icon($entity, 'tiny', array(
                            'use_hover' => false,
                        ));

                        $result = array(
                            'type' => 'user',
                            'name' => $entity->name,
                            'desc' => $entity->username,
                            'guid' => $entity->guid,
                            'label' => $output,
                            'value' => $entity->username,
                            'icon' => $icon,
                            'url' => $entity->getURL(),
                            'html' => elgg_view('input/userpicker/item', array(
                                'entity' => $entity,
                                'input_name' => $input_name,
                            )),
                        );
                        $results[$entity->name . rand(1, 100)] = $result;
                    }
                }
                break;

            default:
                header("HTTP/1.0 400 Bad Request", true);
                echo "livesearch: unknown match_on of $match_type";
                exit;
                break;
        }
    }

    ksort($results);
    header("Content-Type: application/json;charset=utf-8");
    echo json_encode(array_values($results));
    exit;
}

function _elgg_input_init() {
    // register an endpoint for live search / autocomplete.
    elgg_register_page_handler('livesearch', 'input_livesearch_page_handler');
}

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