engine/lib/location.php (r6503/r3548)

Go to the documentation of this file.

<?php
interface Locatable {
    public function setLocation($location);

    public function setLatLong($lat, $long);

    public function getLatitude();

    public function getLongitude();

    public function getLocation();
}

function elgg_geocode_location($location) {
    global $CONFIG;

    // Handle cases where we are passed an array (shouldn't be but can happen if location is a tag field)
    if (is_array($location)) {
        $location = implode(', ', $location);
    }

    $location = sanitise_string($location);

    // Look for cached version
    $cached_location = get_data_row("SELECT * from {$CONFIG->dbprefix}geocode_cache WHERE location='$location'");

    if ($cached_location) {
        return array('lat' => $cached_location->lat, 'long' => $cached_location->long);
    }

    // Trigger geocode event if not cached
    $return = false;
    $return = trigger_plugin_hook('geocode', 'location', array('location' => $location), $return);

    // If returned, cache and return value
    if (($return) && (is_array($return))) {
        $lat = (float)$return['lat'];
        $long = (float)$return['long'];

        // Put into cache at the end of the page since we don't really care that much
        execute_delayed_write_query("INSERT DELAYED INTO {$CONFIG->dbprefix}geocode_cache (location, lat, `long`) VALUES ('$location', '{$lat}', '{$long}') ON DUPLICATE KEY UPDATE lat='{$lat}', `long`='{$long}'");
    }

    return $return;
}

function get_entities_in_area($lat, $long, $radius, $type = "", $subtype = "", $owner_guid = 0, $order_by = "", $limit = 10, $offset = 0, $count = false, $site_guid = 0, $container_guid) {
    global $CONFIG;

    if ($subtype === false || $subtype === null || $subtype === 0) {
        return false;
    }

    $lat = (real)$lat;
    $long = (real)$long;
    $radius = (real)$radius;

    $order_by = sanitise_string($order_by);
    $limit = (int)$limit;
    $offset = (int)$offset;
    $site_guid = (int) $site_guid;
    if ($site_guid == 0) {
        $site_guid = $CONFIG->site_guid;
    }

    $where = array();

    if (is_array($type)) {
        $tempwhere = "";
        if (sizeof($type)) {
            foreach($type as $typekey => $subtypearray) {
                foreach($subtypearray as $subtypeval) {
                    $typekey = sanitise_string($typekey);
                    if (!empty($subtypeval)) {
                        $subtypeval = (int) get_subtype_id($typekey, $subtypeval);
                    } else {
                        $subtypeval = 0;
                    }
                    if (!empty($tempwhere)) $tempwhere .= " or ";
                    $tempwhere .= "(e.type = '{$typekey}' and e.subtype = {$subtypeval})";
                }
            }
        }
        if (!empty($tempwhere)) {
            $where[] = "({$tempwhere})";
        }
    } else {
        $type = sanitise_string($type);
        $subtype = get_subtype_id($type, $subtype);

        if ($type != "") {
            $where[] = "e.type='$type'";
        }

        if ($subtype!=="") {
            $where[] = "e.subtype=$subtype";
        }
    }

    if ($owner_guid != "") {
        if (!is_array($owner_guid)) {
            $owner_array = array($owner_guid);
            $owner_guid = (int) $owner_guid;
            $where[] = "e.owner_guid = '$owner_guid'";
        } else if (sizeof($owner_guid) > 0) {
            $owner_array = array_map('sanitise_int', $owner_guid);
            // Cast every element to the owner_guid array to int
            $owner_guid = implode(",",$owner_guid); //
            $where[] = "e.owner_guid in ({$owner_guid})" ; //
        }
        if (is_null($container_guid)) {
            $container_guid = $owner_array;
        }
    }

    if ($site_guid > 0) {
        $where[] = "e.site_guid = {$site_guid}";
    }

    if (!is_null($container_guid)) {
        if (is_array($container_guid)) {
            foreach($container_guid as $key => $val) $container_guid[$key] = (int) $val;
            $where[] = "e.container_guid in (" . implode(",",$container_guid) . ")";
        } else {
            $container_guid = (int) $container_guid;
            $where[] = "e.container_guid = {$container_guid}";
        }
    }

    // Add the calendar stuff
    $loc_join = "
        JOIN {$CONFIG->dbprefix}metadata loc_start on e.guid=loc_start.entity_guid
        JOIN {$CONFIG->dbprefix}metastrings loc_start_name on loc_start.name_id=loc_start_name.id
        JOIN {$CONFIG->dbprefix}metastrings loc_start_value on loc_start.value_id=loc_start_value.id

        JOIN {$CONFIG->dbprefix}metadata loc_end on e.guid=loc_end.entity_guid
        JOIN {$CONFIG->dbprefix}metastrings loc_end_name on loc_end.name_id=loc_end_name.id
        JOIN {$CONFIG->dbprefix}metastrings loc_end_value on loc_end.value_id=loc_end_value.id
    ";

    $lat_min = $lat - $radius;
    $lat_max = $lat + $radius;
    $long_min = $long - $radius;
    $long_max = $long + $radius;

    $where[] = "loc_start_name.string='geo:lat'";
    $where[] = "loc_start_value.string>=$lat_min";
    $where[] = "loc_start_value.string<=$lat_max";
    $where[] = "loc_end_name.string='geo:long'";
    $where[] = "loc_end_value.string >= $long_min";
    $where[] = "loc_end_value.string <= $long_max";

    if (!$count) {
        $query = "SELECT e.* from {$CONFIG->dbprefix}entities e $loc_join where ";
    } else {
        $query = "SELECT count(e.guid) as total from {$CONFIG->dbprefix}entities e $loc_join where ";
    }
    foreach ($where as $w) {
        $query .= " $w and ";
    }

    $query .= get_access_sql_suffix('e'); // Add access controls

    if (!$count) {
        $query .= " order by n.calendar_start $order_by";
        // Add order and limit
        if ($limit) {
            $query .= " limit $offset, $limit";
        }
        $dt = get_data($query, "entity_row_to_elggstar");
        return $dt;
    } else {
        $total = get_data_row($query);
        return $total->total;
    }
}

function list_entities_location($location, $type= "", $subtype = "", $owner_guid = 0, $limit = 10, $fullview = true, $viewtypetoggle = false, $navigation = true) {
    return list_entities_from_metadata('location', $location, $type, $subtype, $owner_guid, $limit, $fullview, $viewtypetoggle, $navigation);
}

function list_entities_in_area($lat, $long, $radius, $type= "", $subtype = "", $owner_guid = 0, $limit = 10, $fullview = true, $viewtypetoggle = false, $navigation = true) {

    $offset = (int) get_input('offset');
    $count = get_entities_in_area($lat, $long, $radius, $type, $subtype, $owner_guid, "", $limit, $offset, true);
    $entities = get_entities_in_area($lat, $long, $radius, $type, $subtype, $owner_guid, "", $limit, $offset);

    return elgg_view_entity_list($entities, $count, $offset, $limit, $fullview, $viewtypetoggle, $navigation);
}

// Some distances in degrees (approximate)
define("MILE", 0.01515);
define("KILOMETER", 0.00932);

// TODO: get objects within x miles by entities, metadata and relationship

// TODO: List

---