co_ll_location.class.php

Go to the documentation of this file.

<?php
/***************************************************************************************************************************/
defined( 'LGV_DBF_CATCHER' ) or die ( 'Cannot Execute Directly' );  // Makes sure that this file is in the correct context.
 
require_once(CO_Config::db_class_dir().'/co_main_db_record.class.php');
 
/***************************************************************************************************************************/
class CO_LL_Location extends CO_Main_DB_Record {
    protected $_longitude;
    protected $_latitude;
    
    /***********************************************************************************************************************/
    /***********************/
    protected function _default_setup() {
        $default_setup = parent::_default_setup();
        $default_setup['longitude'] = (NULL != $this->_longitude) ? $this->_longitude : 0;
        $default_setup['latitude'] = (NULL != $this->_latitude) ? $this->_latitude : 0;
        
        return $default_setup;
    }
    
    /***********************/
    protected function _build_parameter_array() {
        $ret = parent::_build_parameter_array();
        
        $ret['longitude'] = $this->_longitude;
        $ret['latitude'] = $this->_latitude;
        
        return $ret;
    }
    
    /***********************/
    protected function _km_per_degree() {
        // We do an average. Take four points in a "cross" around the center, then average them. We go out ten Km, so there's some distance.
        $spot0 = Array('longitude' => $this->_longitude, 'latitude' => $this->_latitude);
        $spot1 = Array('longitude' => $this->_longitude + 10.0, 'latitude' => $this->_latitude);
        $spot2 = Array('longitude' => $this->_longitude - 10.0, 'latitude' => $this->_latitude);
        $spot3 = Array('longitude' => $this->_longitude, 'latitude' => $this->_latitude + 10.0);
        $spot4 = Array('longitude' => $this->_longitude, 'latitude' => $this->_latitude - 10.0);
        $distance1 = abs(CO_Main_Data_DB::get_accurate_distance($spot0['latitude'], $spot0['longitude'], $spot1['latitude'], $spot1['longitude']));
        $distance2 = abs(CO_Main_Data_DB::get_accurate_distance($spot0['latitude'], $spot0['longitude'], $spot2['latitude'], $spot2['longitude']));
        $distance3 = abs(CO_Main_Data_DB::get_accurate_distance($spot0['latitude'], $spot0['longitude'], $spot3['latitude'], $spot3['longitude']));
        $distance4 = abs(CO_Main_Data_DB::get_accurate_distance($spot0['latitude'], $spot0['longitude'], $spot4['latitude'], $spot4['longitude']));
        
        return ($distance1 + $distance2 + $distance3 + $distance4) / 40.0;
    }
    
    /***********************/
    protected function _fuzz_me() {
        $ret = Array('longitude' => $this->_longitude, 'latitude' => $this->_latitude);
        
        $fuzz_factor = $this->fuzz_factor();
        if (0 < $fuzz_factor) {
            // The big number gives it lots of fuzz.
            $long_offset = function_exists('random_int') ? random_int(0, 100000 * ($fuzz_factor)) / 100000.0 : rand(0, 100000 * ($fuzz_factor)) / 100000.0;
            $lat_offset = function_exists('random_int') ? random_int(0, 100000 * ($fuzz_factor)) / 100000.0 : rand(0, 100000 * ($fuzz_factor)) / 100000.0;
            
            // Convert the fuziness to degrees.
            $km_per_degree = $this->_km_per_degree();
            $long_offset /= $km_per_degree;
            $lat_offset /= $km_per_degree;
 
            // This determines the direction we go. We make each axis an independent rand().
            $long_offset *= (rand(0, 9) < 5 ? -1.0 : 1.0);
            $lat_offset *= (rand(0, 9) < 5 ? -1.0 : 1.0);
            
            $ret['longitude'] += $long_offset;
            $ret['latitude'] += $lat_offset;
        }
        return $ret;
    }
    
    /***********************************************************************************************************************/
    /***********************/
    public function __construct(    $in_db_object = NULL,               
                                    $in_db_result = NULL,               
                                    $in_owner_id = NULL,                
                                    $in_tags_array = NULL,              
                                    $in_longitude = NULL,               
                                    $in_latitude = NULL,                
                                    $in_fuzz_factor = NULL,             
                                    $in_can_see_through_the_fuzz = NULL 
                                ) {
        parent::__construct($in_db_object, $in_db_result, $in_owner_id, $in_tags_array);
        
        if (NULL != $in_longitude) {
            $this->_longitude = $in_longitude;
        }
        
        if (NULL != $in_latitude) {
            $this->_latitude = $in_latitude;
        }
        
        if ((NULL != $in_fuzz_factor) && (0 != $in_fuzz_factor)) {
            $this->context['fuzz_factor'] = $in_fuzz_factor;
        } elseif (!isset($this->context['fuzz_factor']) || !$this->context['fuzz_factor']) {
            $this->context['fuzz_factor'] = 0;
        }
        
        if (NULL != $in_can_see_through_the_fuzz) {
            $this->context['can_see_through_the_fuzz'] = $in_can_see_through_the_fuzz;
        }
    }
 
    /***********************/
    public function load_from_db(   $in_db_result   
                                    ) {
        $ret = parent::load_from_db($in_db_result);
        
        if ($ret) {
            $this->class_description = 'A basic class for long/lat locations.';
        
            if ($this->_db_object) {
                if (isset($in_db_result['longitude'])) {
                    $this->_longitude = doubleval($in_db_result['longitude']);
                }
        
                if (isset($in_db_result['latitude'])) {
                    $this->_latitude = doubleval($in_db_result['latitude']);
                }
            }
        
            $ll_string = ((NULL != $this->_longitude) && (NULL != $this->_latitude)) ? "($this->_longitude, $this->_latitude)" : '';
        
            $this->class_description = "Generic longitude/latitude Class.";
            $this->instance_description = isset($this->name) && $this->name ? "$this->name $ll_string" : $ll_string;
        }
        
        return $ret;
    }
    
    /***********************/
    public function update_db() {
        $ret = parent::update_db();
        if ($ret) {
            $ll_string = ((NULL != $this->_longitude) && (NULL != $this->_latitude)) ? "($this->_longitude, $this->_latitude)" : '';
        
            $this->instance_description = isset($this->name) && $this->name ? "$this->name $ll_string" : $ll_string;
        }
        
        return $ret;
    }
    
    /***********************/
    public function set_longitude(  $in_new_value
                                    ) {
        $ret = false;
        
        if (isset($in_new_value) && $this->user_can_write()) {
            $this->_longitude = floatval($in_new_value);
            $ret = $this->update_db();
        }
        
        return $ret;
    }
    
    /***********************/
    public function set_latitude(   $in_new_value
                                    ) {
        $ret = false;
        
        if (isset($in_new_value) && $this->user_can_write()) {
            $this->_latitude = floatval($in_new_value);
            $ret = $this->update_db();
        }
        
        return $ret;
    }
    
    /***********************/
     public function fuzz_factor() {
        return isset($this->context['fuzz_factor']) ? abs(floatval($this->context['fuzz_factor'])) : 0.0;
    }
 
    /***********************/
    public function is_fuzzy() {
        return 0.0 < $this->fuzz_factor();
    }
    
    /***********************/
    public function set_fuzz_factor(   $in_new_value    
                                    ) {
        $ret = false;
        
        $in_new_value = abs(floatval($in_new_value));
        
        if ($this->user_can_write()) {
            if (0 == $in_new_value) {
                unset($this->context['fuzz_factor']);
            } else {
                $this->context['fuzz_factor'] = $in_new_value;
            }
            
            $ret = $this->update_db();
        }
        
        return $ret;
    }
    
    /***********************/
    public function raw_longitude() {
        if ($this->i_can_see_clearly_now()) {
            return $this->_longitude;
        } else {
            return $this->longitude();
        }
    }
    
    /***********************/
    public function raw_latitude() {
        if ($this->i_can_see_clearly_now()) {
            return $this->_latitude;
        } else {
            return $this->latitude();
        }
    }
    
    /***********************/
    public function longitude() {
        return $this->_fuzz_me()['longitude'];
    }
    
    /***********************/
    public function latitude() {
        return $this->_fuzz_me()['latitude'];
    }
    
    /***********************/
    public function set_can_see_through_the_fuzz(   $in_id  
                                                ) {
        $ret = false;
        
        if ($this->user_can_write()) {
            $in_id = intval($in_id);
            
            if (0 == $in_id) {
                unset($this->context['can_see_through_the_fuzz']);
            } else {
                $ids = $this->get_access_object()->get_security_ids();
                
                $in_id = (in_array($in_id, $ids) || $this->get_access_object()->god_mode()) ? $in_id : 0;
                
                if ($in_id) {
                    $this->context['can_see_through_the_fuzz'] = $in_id;
                } else {
                    unset($this->context['can_see_through_the_fuzz']);
                }
            }
            
            $ret = $this->update_db();
        }
        
        return $ret;
    }
    
    /***********************/
    public function can_see_through_the_fuzz() {
        $ret = 0;
        
        $ids = $this->get_access_object()->get_security_ids();
 
        $my_see_item = intval($this->write_security_id);
        
        $the_id = isset($this->context['can_see_through_the_fuzz']) ? intval($this->context['can_see_through_the_fuzz']) : 0;
        
        if (isset($ids) && is_array($ids) && count($ids)) {
            $ret = in_array($the_id, $ids) ? $the_id : 0;
        }
        
        return $ret;
    }
    
    /***********************/
    public function i_can_see_clearly_now() {
        $ret = !$this->is_fuzzy() || $this->user_can_write();  // If we aren't fuzzed, then, no problem. Peep away. Writers can see.
        
        if (!$ret && $this->get_access_object()->security_db_available()) { // Only logged-in users get to see clearly.
            if (!$ret && isset($this->context['can_see_through_the_fuzz'])) {
                $ids = $this->get_access_object()->get_security_ids();
            
                $my_see_item = intval($this->context['can_see_through_the_fuzz']);
                if (isset($ids) && is_array($ids) && count($ids)) {
                    $ret = in_array($my_see_item, $ids);
                }
            }
        }
        return $ret;
    }
};