MapMarker.php

<?php namespace ProcessWire;

/**
 * Class to hold an address and geocode it to latitude/longitude
 * 
 * @property string $lat
 * @property string $lng
 * @property string $address
 * @property int $status
 * @property int $zoom
 * @property bool $skipGeocode
 * @property string $statusString
 *
 */
class MapMarker extends WireData {

	const statusNoGeocode = -100;

	protected $geocodeStatuses = array(
		0 => 'N/A',
		1 => 'OK',
		2 => 'OK_ROOFTOP', 
		3 => 'OK_RANGE_INTERPOLATED',
		4 => 'OK_GEOMETRIC_CENTER',
		5 => 'OK_APPROXIMATE',

		-1 => 'UNKNOWN',
		-2 => 'ZERO_RESULTS',
		-3 => 'OVER_QUERY_LIMIT',
		-4 => 'REQUEST_DENIED',
		-5 => 'INVALID_REQUEST',

		-100 => 'Geocode OFF', // RCD
	);

	protected $geocodedAddress = '';

	public function __construct() {
		parent::__construct();
		$this->set('lat', '');
		$this->set('lng', '');
		$this->set('address', ''); 
		$this->set('status', 0); 
		$this->set('zoom', 0); 
		// temporary runtime property to indicate the geocode should be skipped
		$this->set('skipGeocode', false);
		$this->set('statusString', '');
	}

	public function set($key, $value) {

		if($key == 'lat' || $key == 'lng') {
			// if value isn't numeric, then it's not valid: make it blank
			if(strpos($value, ',') !== false) $value = str_replace(',', '.', $value); // convert 123,456 to 123.456
			if(!is_numeric($value)) $value = '';	

		} else if($key == 'address') {
			$value = $this->wire()->sanitizer->text($value);

		} else if($key == 'status') { 
			$value = (int) $value; 
			if(!isset($this->geocodeStatuses[$value])) $value = -1; // -1 = unknown
		} else if($key == 'zoom') {
			$value = (int) $value; 
		}

		return parent::set($key, $value);
	}

	public function get($key) {
		if($key == 'statusString') return str_replace('_', ' ', $this->geocodeStatuses[$this->status]); 
		return parent::get($key);
	}

	public function geocode() {
		if($this->skipGeocode) return -100;

		// check if address was already geocoded
		if($this->geocodedAddress == $this->address) return $this->status; 
		$this->geocodedAddress = $this->address;

		$url = "https://maps.googleapis.com/maps/api/geocode/json?address=" . urlencode($this->address);
	
		/** @var FieldtypeMapMarker $fieldtype */
		$fieldtype = $this->modules->get('FieldtypeMapMarker');
		$apiKey = $fieldtype->get('googleApiKey');
		if($apiKey) $url .= "&key=$apiKey";
		$http = new WireHttp();
		$json = $http->getJSON($url, true);
		if(empty($json['status'])) $json['status'] = 'No response';

		if($json['status'] != 'OK') {
			$this->error("Error geocoding address: $json[status] ($url)");
			if(isset($json['status'])) $this->status = (int) array_search($json['status'], $this->geocodeStatuses);
				else $this->status = -1; 
			$this->lat = 0;
			$this->lng = 0;
			return $this->status; 
		}

		$geometry = $json['results'][0]['geometry'];
		$location = $geometry['location'];
		$locationType = $geometry['location_type'];

		$this->lat = $location['lat'];
		$this->lng = $location['lng'];

		$statusString = $json['status'] . '_' . $locationType; 
		$status = array_search($statusString, $this->geocodeStatuses); 
		if($status === false) $status = 1; // OK	

		$this->status = $status; 
		$this->message("Geocode {$this->statusString}: '{$this->address}'"); 

		return $this->status; 
	}

	/**
	 * If accessed as a string, then just output the lat, lng coordinates
	 *
	 */
	public function __toString() {
		return "$this->address ($this->lat, $this->lng, $this->zoom) [$this->statusString]";
	}

}