BetterBrief / silverstripe-googlemapfield

src/GoogleMapField.php

<?php

/**
 * GoogleMapField
 * Lets you record a precise location using latitude/longitude fields to a
 * DataObject. Displays a map using the Google Maps API. The user may then
 * choose where to place the marker; the landing coordinates are then saved.
 * You can also search for locations using the search box, which uses the Google
 * Maps Geocoding API.
 * @author <@willmorgan>
 */

namespace BetterBrief;

use SilverStripe\Forms\FormField;
use SilverStripe\ORM\DataObject;
use SilverStripe\Forms\HiddenField;
use SilverStripe\Forms\TextField;
use SilverStripe\View\Requirements;
use SilverStripe\ORM\DataObjectInterface;
use SilverStripe\Forms\FieldList;
use SilverStripe\Core\Convert;

class GoogleMapField extends FormField {

	protected $data;

	/**
	 * @var FormField
	 */
	protected $latField;

	/**
	 * @var FormField
	 */
	protected $lngField;

	/**
	 * @var FormField
	 */
	protected $zoomField;

	/**
	 * @var FormField
	 */
	protected $boundsField;

	/**
	 * The merged version of the default and user specified options
	 * @var array
	 */
	protected $options = array();

	/**
	 * @param DataObject $data The controlling dataobject
	 * @param string $title The title of the field
	 * @param array $options Various settings for the field
	 */
	public function __construct(DataObject $data, $title, $options = array()) {
		$this->data = $data;

		// Set up fieldnames
		$this->setupOptions($options);

		$this->setupChildren();

		parent::__construct($this->getName(), $title);
	}

	// Auto generate a name
	public function getName() {
		$fieldNames = $this->getOption('field_names');
		return sprintf(
			'%s_%s_%s',
			$this->data->class,
			$fieldNames['Latitude'],
			$fieldNames['Longitude']
		);
	}

	/**
	 * Merge options preserving the first level of array keys
	 * @param array $options
	 */
	public function setupOptions(array $options) {
		$this->options = static::config()->default_options;
		foreach($this->options as $name => &$value) {
			if(isset($options[$name])) {
				if(is_array($value)) {
					$value = array_merge($value, $options[$name]);
				}
				else {
					$value = $options[$name];
				}
			}
		}
	}

	/**
	 * Set up child hidden fields, and optionally the search box.
	 * @return FieldList the children
	 */
	public function setupChildren() {
		$name = $this->getName();

		// Create the latitude/longitude hidden fields
		$this->latField = HiddenField::create(
			$name.'[Latitude]',
			'Lat',
			$this->recordFieldData('Latitude')
		)->addExtraClass('googlemapfield-latfield no-change-track');

		$this->lngField = HiddenField::create(
			$name.'[Longitude]',
			'Lng',
			$this->recordFieldData('Longitude')
		)->addExtraClass('googlemapfield-lngfield no-change-track');

		$this->zoomField = HiddenField::create(
			$name.'[Zoom]',
			'Zoom',
			$this->recordFieldData('Zoom')
		)->addExtraClass('googlemapfield-zoomfield no-change-track');
		$this->boundsField = HiddenField::create(
			$name.'[Bounds]',
			'Bounds',
			$this->recordFieldData('Bounds')
		)->addExtraClass('googlemapfield-boundsfield no-change-track');
		$this->children = new FieldList(

The property children does not exist on object<BetterBrief\GoogleMapField>. Since you implemented __set, maybe consider adding a @property annotation.

			$this->latField,
			$this->lngField,
			$this->zoomField,
			$this->boundsField
		);

		if($this->options['show_search_box']) {
			$this->children->push(

The property children does not exist on object<BetterBrief\GoogleMapField>. Since you implemented __get, maybe consider adding a @property annotation.

				TextField::create('Search')
				->addExtraClass('googlemapfield-searchfield')
				->setAttribute('placeholder', 'Search for a location')
			);
		}

		return $this->children;

The property children does not exist on object<BetterBrief\GoogleMapField>. Since you implemented __get, maybe consider adding a @property annotation.

	}

	/**
	 * @param array $properties
	 * @see https://developers.google.com/maps/documentation/javascript/reference
	 * {@inheritdoc}
	 */
	public function Field($properties = array()) {
		$jsOptions = array(
			'coords' => array(
				$this->recordFieldData('Latitude'),
				$this->recordFieldData('Longitude')
			),
			'map' => array(
				'zoom' => $this->recordFieldData('Zoom') ?: $this->getOption('map.zoom'),
				'mapTypeId' => 'ROADMAP',
			),
		);

		$jsOptions = array_replace_recursive($jsOptions, $this->options);
		$this->setAttribute('data-settings', Convert::array2json($jsOptions));
		$this->requireDependencies();
		return parent::Field($properties);
	}

	/**
	 * Set up and include any frontend requirements
	 * @return void
	 */
	protected function requireDependencies() {
		$gmapsParams = array(
			'callback' => 'googlemapfieldInit',
		);
		if($key = $this->getOption('api_key')) {
			$gmapsParams['key'] = $key;
		}
		$this->extend('updateGoogleMapsParams', $gmapsParams);
        Requirements::css('betterbrief/silverstripe-googlemapfield: client/css/GoogleMapField.css');
        Requirements::javascript('betterbrief/silverstripe-googlemapfield: client/js/GoogleMapField.js');
		Requirements::javascript('//maps.googleapis.com/maps/api/js?' . http_build_query($gmapsParams));
	}

	/**
	 * {@inheritdoc}
	 */
	public function setValue($record, $data = null) {
		$this->latField->setValue(
			$record['Latitude']
		);
		$this->lngField->setValue(
			$record['Longitude']
		);
		$this->zoomField->setValue(
			$record['Zoom']
		);
		$this->boundsField->setValue(
			$record['Bounds']
		);
		return $this;
	}

	/**
	 * Take the latitude/longitude fields and save them to the DataObject.
	 * {@inheritdoc}
	 */
	public function saveInto(DataObjectInterface $record) {
		$record->setCastedField($this->childFieldName('Latitude'), $this->latField->dataValue());
		$record->setCastedField($this->childFieldName('Longitude'), $this->lngField->dataValue());
		$record->setCastedField($this->childFieldName('Zoom'), $this->zoomField->dataValue());
		$record->setCastedField($this->childFieldName('Bounds'), $this->boundsField->dataValue());
		return $this;
	}

	/**
	 * @return FieldList The Latitude/Longitude fields
	 */
	public function getChildFields() {
		return $this->children;

The property children does not exist on object<BetterBrief\GoogleMapField>. Since you implemented __get, maybe consider adding a @property annotation.

	}

	protected function childFieldName($name) {

The return type could not be reliably inferred; please add a @return annotation.

		$fieldNames = $this->getOption('field_names');
		return $fieldNames[$name];
	}

	protected function recordFieldData($name) {

The return type could not be reliably inferred; please add a @return annotation.

		$fieldName = $this->childFieldName($name);
		return $this->data->$fieldName ?: $this->getDefaultValue($name);
	}

	public function getDefaultValue($name) {

The return type could not be reliably inferred; please add a @return annotation.

		$fieldValues = $this->getOption('default_field_values');
		return isset($fieldValues[$name]) ? $fieldValues[$name] : null;
	}

	/**
	 * @return string The VALUE of the Latitude field
	 */
	public function getLatData() {
		$fieldNames = $this->getOption('field_names');
		return $this->data->$fieldNames['Latitude'];
	}

	/**
	 * @return string The VALUE of the Longitude field
	 */
	public function getLngData() {
		$fieldNames = $this->getOption('field_names');
		return $this->data->$fieldNames['Longitude'];
	}

	/**
	 * Get the merged option that was set on __construct
	 * @param string $name The name of the option
	 * @return mixed
	 */
	public function getOption($name) {
		// Quicker execution path for "."-free names
		if (strpos($name, '.') === false) {
			if (isset($this->options[$name])) return $this->options[$name];
		} else {
			$names = explode('.', $name);

			$var = $this->options;

			foreach($names as $n) {
				if(!isset($var[$n])) {
					return null;
				}
				$var = $var[$n];
			}

			return $var;
		}
	}

	/**
	 * Set an option for this field
	 * @param string $name The name of the option to set
	 * @param mixed $val The value of said option
	 * @return $this
	 */
	public function setOption($name, $val) {
		// Quicker execution path for "."-free names
		if(strpos($name,'.') === false) {
			$this->options[$name] = $val;
		} else {
			$names = explode('.', $name);

			// We still want to do this even if we have strict path checking for legacy code
			$var = &$this->options;

			foreach($names as $n) {
				$var = &$var[$n];
			}

			$var = $val;
		}
		return $this;
	}

}