BAOBAB
CO_US_Place Class Reference
Inheritance diagram for CO_US_Place:
Collaboration diagram for CO_US_Place:

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)
 
 get_address_elements ()
 
- Public Member Functions inherited from CO_Place
 set_address_elements ( $in_tags, $dont_save=false)
 
 set_address_element ( $in_index, $in_value, $dont_save=false)
 
 set_address_element_by_key ( $in_key, $in_value, $dont_save=false)
 
 get_address_element_by_index ( $in_index)
 
 lookup_address ()
 
 geocode_long_lat ()
 
 get_readable_address ( $with_venue=true)
 
 set_tags_from_address_elements ()
 
- Public Member Functions inherited from 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)
 
 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

 _get_address_element_labels ()
 
- Protected Member Functions inherited from CO_LL_Location
 _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 ()
 

Additional Inherited Members

- Public Attributes inherited from CO_Place
 $address_elements = Array()
 These are the address elements we use for creating lookup addresses. More...
 
 $google_geocode_uri_prefix = NULL
 This is the Geocode URI for the Google Geocode. More...
 
 $google_lookup_uri_prefix = NULL
 This is the lookup URI for the Google reverse Geocode. More...
 
 $region_bias = NULL
 This can be set by subclasses in order to set a region bias. More...
 
- 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'
 
- Protected Attributes inherited from CO_LL_Location
 $_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...
 

Detailed Description

This is a specialization of the location class. It adds support for US addresses, and uses the first seven tags for this.

Definition at line 34 of file co_us_place.class.php.

Constructor & Destructor Documentation

◆ __construct()

CO_US_Place::__construct (   $in_db_object = NULL,
  $in_db_result = NULL,
  $in_owner_id = NULL,
  $in_tags_array = NULL,
  $in_longitude = NULL,
  $in_latitude = NULL 
)

Constructor (Initializer)

Parameters
$in_db_objectThe database object for this instance.
$in_db_resultThe database row for this instance (associative array, with database keys).
$in_owner_idThe ID of the object (in the database) that "owns" this instance.
$in_tags_arrayAn array of up to 10 strings, with address information in the first 7. Order is important:
  • 0: Venue
  • 1: Street Address
  • 2: Extra Information
  • 3: Town
  • 4: County
  • 5: State
  • 6: ZIP Code

Associative keys are not used. The array should be in that exact order.

Parameters
$in_longitudeAn initial longitude value.
$in_latitudeAn initial latitude value.

Reimplemented from CO_Place.

Reimplemented in CO_US_Place_Collection.

Definition at line 59 of file co_us_place.class.php.

75  {
76 
77  $this->region_bias = 'us';
78 
79  parent::__construct($in_db_object, $in_db_result, $in_owner_id, $in_tags_array, $in_longitude, $in_latitude);
80 
81  $this->class_description = "This is a 'Place' Class for US Addresses.";
82  }

Member Function Documentation

◆ _get_address_element_labels()

CO_US_Place::_get_address_element_labels ( )
protected

This fetches string labels to be used as keys for the fixed tags.

Returns
an array of strings, which will correspond to the first six tags.

Reimplemented from CO_Place.

Definition at line 42 of file co_us_place.class.php.

References CO_CHAMELEON_Lang_Common\$chameleon_co_place_tag_0, CO_CHAMELEON_Lang_Common\$chameleon_co_place_tag_1, CO_CHAMELEON_Lang_Common\$chameleon_co_place_tag_2, CO_CHAMELEON_Lang_Common\$chameleon_co_place_tag_3, CO_CHAMELEON_Lang_Common\$chameleon_co_place_tag_4, CO_CHAMELEON_Lang_Common\$chameleon_co_place_tag_5, and CO_CHAMELEON_Lang_Common\$chameleon_co_place_tag_6.

◆ get_address_elements()

CO_US_Place::get_address_elements ( )
Returns
the address elements, in an associative array.

Reimplemented from CO_Place.

Definition at line 88 of file co_us_place.class.php.

88  {
89  $ret = parent::get_address_elements();
90  $ret[CO_CHAMELEON_Lang_Common::$chameleon_co_place_tag_7] = 'USA'; // Fixed, for USA.
91 
92  return $ret;
93  }

References CO_CHAMELEON_Lang_Common\$chameleon_co_place_tag_7.