Inheritance diagram for CO_LL_Location:

Collaboration diagram for CO_LL_Location:

Public Member Functions
	__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)

	load_from_db ( $in_db_result)

	update_db ()

	set_longitude ( $in_new_value)

	set_latitude ( $in_new_value)

	fuzz_factor ()

	is_fuzzy ()

	set_fuzz_factor ( $in_new_value)

	raw_longitude ()

	raw_latitude ()

	longitude ()

	latitude ()

	set_can_see_through_the_fuzz ( $in_id)

	can_see_through_the_fuzz ()

	i_can_see_clearly_now ()

Public Member Functions inherited from CO_Main_DB_Record
	__construct ( $in_db_object=NULL, $in_db_result=NULL, $in_owner_id=NULL, $in_tags_array=NULL)

	set_owner_id ( $in_new_id)

	set_tags ( $in_tags_array)

	set_tag ( $in_tag_index, $in_tag_value)

	get_payload ()

	set_payload ( $in_payload)

	owner_id ()

	tags ()

Public Member Functions inherited from A_CO_DB_Table_Base
	__construct ( $in_db_object=NULL, $in_db_result=NULL)

	set_batch_mode ()

	clear_batch_mode ()

	id ()

	lock ()

	locked ()

	danger_will_robinson_danger_clear_id ()

	user_can_read ()

	user_can_write ()

	set_read_security_id ($in_new_id)

	set_write_security_id ($in_new_id)

	set_name ($in_new_value)

	delete_from_db ()

	reload_from_db ()

	get_access_object ()

	get_lang ()

	set_lang ( $in_lang_id=NULL)

Protected Member Functions
	_default_setup ()

	_build_parameter_array ()

	_km_per_degree ()

	_fuzz_me ()

Protected Member Functions inherited from A_CO_DB_Table_Base
	_badger_serialize ( $in_data)

	_badger_unserialize ( $in_data)

	_write_to_db ()

	_seppuku ()

Protected Attributes
	$_longitude

	$_latitude

Protected Attributes inherited from CO_Main_DB_Record
	$_owner_id

	$_tags

Protected Attributes inherited from A_CO_DB_Table_Base
	$_db_object
	This is the actual database object that "owns" this instance. It should not be exposed beyond this class or subclasses, thereof. More...

	$_id
	This is the within-table unique ID of this record. More...

	$_batch_mode
	If this is true, then the write_record call will not be made in update_db. It will be done when clear_batch_mode() is called, instead. More...

Additional Inherited Members
Public Attributes inherited from A_CO_DB_Table_Base
	$class_description
	This is a description of the class (not the instance). More...

	$instance_description
	This is a description that describes the instance. More...

	$last_access
	This is a UNIX epoch date that describes the last modification. The default is UNIX Day Two (in case of UTC timezone issues). More...

	$name
	This is the "object_name" string field. More...

	$read_security_id
	This is a single integer, defining the security ID required to view the record. If it is 0, then it is "open.". More...

	$write_security_id
	This is a single integer, defining the required security token to modify the record. If it is 0, then any logged-in user can modify. More...

	$context
	This is a mixed associative array, containing fields for the object. More...

	$error
	If there is an error, it is contained here, in a LGV_Error instance. More...

Static Public Attributes inherited from CO_Main_DB_Record
static	$s_table_name = 'co_data_nodes'

Detailed Description

This is a specialization of the basic data class, implementing the long/lat fields (built into the table structure, but unused by base classes).

It has a "fuzz factor" built in. This is because some organizations, for reasons of privacy or law, don't want exact locations disclosed.

You can define a "fuzz factor" of how many kilometers you want as a "fuzzy circle" around the point.

Definition at line 38 of file co_ll_location.class.php.

Constructor & Destructor Documentation

◆ __construct()

CO_LL_Location::__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`
	)

Constructor (Initializer)

Parameters

$in_db_object	The database object for this instance.
$in_db_result	The database row for this instance (associative array, with database keys).
$in_owner_id	The ID of the object (in the database) that "owns" this instance.
$in_tags_array	An array of strings, up to ten elements long, for the tags.
$in_longitude	An initial longitude value.
$in_latitude	An initial latitude value.
$in_fuzz_factor	An initial "fuzz factor" value.
$in_can_see_through_the_fuzz	This is a security token for being able to see the value as a raw value (unfuzzed).

Definition at line 130 of file co_ll_location.class.php.

                                   {
         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;
         }
     }

Member Function Documentation

◆ _build_parameter_array()

CO_LL_Location::_build_parameter_array ( )

protected

This builds up the basic section of the instance database record. It should be overloaded, and the parent called before adding new fields.

This method overloads (and calls) the base class method.

Returns: an associative array, in database record form.

Reimplemented from CO_Main_DB_Record.

Definition at line 69 of file co_ll_location.class.php.

                                                 {
         $ret = parent::_build_parameter_array();
         
         $ret['longitude'] = $this->_longitude;
         $ret['latitude'] = $this->_latitude;
         
         return $ret;
     }

◆ _default_setup()

CO_LL_Location::_default_setup ( )

protected

This is called to populate the object fields for this class with default values. These use the SQL table tags.

This should be subclassed, and the parent should be called before applying specific instance properties.

This method overloads (and calls) the base class method.

Returns: An associative array, simulating a database read.

Reimplemented from CO_Main_DB_Record.

Definition at line 53 of file co_ll_location.class.php.

                                         {
         $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;
     }

◆ _fuzz_me()

CO_LL_Location::_fuzz_me ( )

protected

Returns: an associative array, with a "fuzzed" long/lat (if there is no fuzz factor, it is the raw long/lat).

Definition at line 101 of file co_ll_location.class.php.

                                   {
         $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;
     }

◆ _km_per_degree()

CO_LL_Location::_km_per_degree ( )

protected

Returns: a floating-point number, with the Km per degree long/lat (Changes for different latitudes, and is only good for the immediate vicinity).

Definition at line 82 of file co_ll_location.class.php.

                                         {
         // 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;
     }

References CO_Main_Data_DB\get_accurate_distance().

Here is the call graph for this function:

◆ can_see_through_the_fuzz()

CO_LL_Location::can_see_through_the_fuzz ( )

Getter for a security ID token that can see past the fuzz factor.

Returns: an integer, with the ID (as long as we can read it). 0 if we don't have permission for the ID, or there is none.

Definition at line 377 of file co_ll_location.class.php.

                                                {
         $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;
     }

◆ fuzz_factor()

CO_LL_Location::fuzz_factor ( )

Getter for fuzz factor.

Returns: the fuzz factor, as a float. If it is not set, then it is zero.

Definition at line 253 of file co_ll_location.class.php.

                                    {
         return isset($this->context['fuzz_factor']) ? abs(floatval($this->context['fuzz_factor'])) : 0.0;
     }

◆ i_can_see_clearly_now()

CO_LL_Location::i_can_see_clearly_now ( )

Returns: true, if current user has the ability to see the raw values.

Definition at line 397 of file co_ll_location.class.php.

                                             {
         $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;
     }

◆ is_fuzzy()

CO_LL_Location::is_fuzzy ( )

Returns: true, if the instance has a "fuzz factor."

Definition at line 261 of file co_ll_location.class.php.

                                {
         return 0.0 < $this->fuzz_factor();
     }

◆ latitude()

CO_LL_Location::latitude ( )

This returns the longitude, with any "fuzz factor" applied.

Returns: The current latitude value.

Definition at line 334 of file co_ll_location.class.php.

                                {
         return $this->_fuzz_me()['latitude'];
     }

◆ load_from_db()

CO_LL_Location::load_from_db ( $in_db_result )

This function sets up this instance, according to the DB-formatted associative array passed in.

Returns: true, if the instance was able to set itself up to the provided array.

Parameters

$in_db_result This is an associative array, formatted as a database row response.

Reimplemented from CO_Main_DB_Record.

Reimplemented in CO_User_Collection, CO_US_Place_Collection, CO_Place_Collection, CO_KeyValue_CO_Collection, and CO_Collection.

Definition at line 166 of file co_ll_location.class.php.

                                       {
         $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;
     }

◆ longitude()

CO_LL_Location::longitude ( )

This returns the longitude, with any "fuzz factor" applied.

Returns: The current longitude value.

Definition at line 324 of file co_ll_location.class.php.

                                 {
         return $this->_fuzz_me()['longitude'];
     }

◆ raw_latitude()

CO_LL_Location::raw_latitude ( )

This returns the latitude. However, if the user is not logged in, or doesn't have read rights (which shouldn't happen, anyway), they will only get the "fuzzed" version.

Returns: The current longitude value.

Definition at line 310 of file co_ll_location.class.php.

                                    {
         if ($this->i_can_see_clearly_now()) {
             return $this->_latitude;
         } else {
             return $this->latitude();
         }
     }

Referenced by CO_Place\geocode_long_lat().

Here is the caller graph for this function:

◆ raw_longitude()

CO_LL_Location::raw_longitude ( )

This returns the longitude. However, if the user is not logged in, or doesn't have read rights (which shouldn't happen, anyway), they will only get the "fuzzed" version.

Returns: The current longitude value.

Definition at line 296 of file co_ll_location.class.php.

                                     {
         if ($this->i_can_see_clearly_now()) {
             return $this->_longitude;
         } else {
             return $this->longitude();
         }
     }

Referenced by CO_Place\geocode_long_lat().

Here is the caller graph for this function:

◆ set_can_see_through_the_fuzz()

CO_LL_Location::set_can_see_through_the_fuzz ( $in_id )

Setter for a security ID token that can see past the fuzz factor.

Returns: true, if the save was successful.

Parameters

$in_id The ID to set. If 0 or NULL, the value is removed.

Definition at line 344 of file co_ll_location.class.php.

                                                   {
         $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;
     }

◆ set_fuzz_factor()

CO_LL_Location::set_fuzz_factor ( $in_new_value )

Setter for fuzz factor.

Returns: true, if the save was successful.

Parameters

$in_new_value The new value must be a positive floating-point value over (and including) 0. If zero, the factor is deleted.

Definition at line 271 of file co_ll_location.class.php.

                                       {
         $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;
     }

◆ set_latitude()

CO_LL_Location::set_latitude ( $in_new_value )

Setter for latitude.

Returns: true, if the save was successful.

Definition at line 235 of file co_ll_location.class.php.

                                       {
         $ret = false;
         
         if (isset($in_new_value) && $this->user_can_write()) {
             $this->_latitude = floatval($in_new_value);
             $ret = $this->update_db();
         }
         
         return $ret;
     }

◆ set_longitude()

CO_LL_Location::set_longitude ( $in_new_value )

Setter for longitude.

Returns: true, if the save was successful.

Definition at line 217 of file co_ll_location.class.php.

                                       {
         $ret = false;
         
         if (isset($in_new_value) && $this->user_can_write()) {
             $this->_longitude = floatval($in_new_value);
             $ret = $this->update_db();
         }
         
         return $ret;
     }

◆ update_db()

CO_LL_Location::update_db ( )

This is a "trigger" to update the database with the current instance state.

This checks to make sure the user has write permission before saving.

Returns: true, if a DB update was successful.

Reimplemented from A_CO_DB_Table_Base.

Definition at line 200 of file co_ll_location.class.php.

                                 {
         $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;
     }

Referenced by CO_Place\set_address_element(), and CO_Place\set_address_elements().

Here is the caller graph for this function:

Member Data Documentation

◆ $_latitude

CO_LL_Location::$_latitude

protected

Definition at line 40 of file co_ll_location.class.php.

◆ $_longitude

CO_LL_Location::$_longitude

protected

Definition at line 39 of file co_ll_location.class.php.

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _build_parameter_array()

◆ _default_setup()

◆ _fuzz_me()

◆ _km_per_degree()

◆ can_see_through_the_fuzz()

◆ fuzz_factor()

◆ i_can_see_clearly_now()

◆ is_fuzzy()

◆ latitude()

◆ load_from_db()

◆ longitude()

◆ raw_latitude()

◆ raw_longitude()

◆ set_can_see_through_the_fuzz()

◆ set_fuzz_factor()

◆ set_latitude()

◆ set_longitude()

◆ update_db()

Member Data Documentation

◆ $_latitude

◆ $_longitude