BetterBrief / silverstripe-googlemapfield

code/GoogleMapField.php

Doc Comments +3 added lines

@@ -210,6 +210,9 @@
         return $fieldNames[$name];
     }
 
+    /**
+     * @param string $name
+     */
     protected function recordFieldData($name)
     {
         $fieldName = $this->childFieldName($name);

Indentation +281 added lines, -281 removed lines

@@ -12,285 +12,285 @@
 class GoogleMapField extends FormField
 {
 
-    protected $data;
-
-    /**
-     * @var FormField
-     */
-    protected $latField;
-
-    /**
-     * @var FormField
-     */
-    protected $lngField;
-
-    /**
-     * @var FormField
-     */
-    protected $zoomField;
-
-    /**
-     * 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');
-
-        $this->lngField = HiddenField::create(
-            $name.'[Longitude]',
-            'Lng',
-            $this->recordFieldData('Longitude')
-        )->addExtraClass('googlemapfield-lngfield');
-
-        $this->zoomField = HiddenField::create(
-            $name.'[Zoom]',
-            'Zoom',
-            $this->recordFieldData('Zoom')
-        )->addExtraClass('googlemapfield-zoomfield');
-
-        $this->children = new FieldList(
-            $this->latField,
-            $this->lngField,
-            $this->zoomField
-        );
-
-        if ($this->options['show_search_box']) {
-            $this->children->push(
-                TextField::create('Search')
-                ->addExtraClass('googlemapfield-searchfield')
-                ->setAttribute('placeholder', 'Search for a location')
-            );
-        }
-
-        return $this->children;
-    }
-
-    /**
-     * @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($this->options, $jsOptions);
-        $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;
-        }
-        Requirements::css(GOOGLEMAPFIELD_BASE .'/css/GoogleMapField.css');
-        Requirements::javascript(GOOGLEMAPFIELD_BASE .'/javascript/GoogleMapField.js');
-        Requirements::javascript('//maps.googleapis.com/maps/api/js?' . http_build_query($gmapsParams));
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function setValue($record)
-    {
-        $this->latField->setValue(
-            $record['Latitude']
-        );
-        $this->lngField->setValue(
-            $record['Longitude']
-        );
-        $this->zoomField->setValue(
-            $record['Zoom']
-        );
-        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());
-        return $this;
-    }
-
-    /**
-     * @return FieldList The Latitude/Longitude fields
-     */
-    public function getChildFields()
-    {
-        return $this->children;
-    }
-
-    protected function childFieldName($name)
-    {
-        $fieldNames = $this->getOption('field_names');
-        return $fieldNames[$name];
-    }
-
-    protected function recordFieldData($name)
-    {
-        $fieldName = $this->childFieldName($name);
-        return $this->data->$fieldName ?: $this->getDefaultValue($name);
-    }
-
-    public function getDefaultValue($name)
-    {
-        $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;
-    }
+	protected $data;
+
+	/**
+	 * @var FormField
+	 */
+	protected $latField;
+
+	/**
+	 * @var FormField
+	 */
+	protected $lngField;
+
+	/**
+	 * @var FormField
+	 */
+	protected $zoomField;
+
+	/**
+	 * 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');
+
+		$this->lngField = HiddenField::create(
+			$name.'[Longitude]',
+			'Lng',
+			$this->recordFieldData('Longitude')
+		)->addExtraClass('googlemapfield-lngfield');
+
+		$this->zoomField = HiddenField::create(
+			$name.'[Zoom]',
+			'Zoom',
+			$this->recordFieldData('Zoom')
+		)->addExtraClass('googlemapfield-zoomfield');
+
+		$this->children = new FieldList(
+			$this->latField,
+			$this->lngField,
+			$this->zoomField
+		);
+
+		if ($this->options['show_search_box']) {
+			$this->children->push(
+				TextField::create('Search')
+				->addExtraClass('googlemapfield-searchfield')
+				->setAttribute('placeholder', 'Search for a location')
+			);
+		}
+
+		return $this->children;
+	}
+
+	/**
+	 * @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($this->options, $jsOptions);
+		$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;
+		}
+		Requirements::css(GOOGLEMAPFIELD_BASE .'/css/GoogleMapField.css');
+		Requirements::javascript(GOOGLEMAPFIELD_BASE .'/javascript/GoogleMapField.js');
+		Requirements::javascript('//maps.googleapis.com/maps/api/js?' . http_build_query($gmapsParams));
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function setValue($record)
+	{
+		$this->latField->setValue(
+			$record['Latitude']
+		);
+		$this->lngField->setValue(
+			$record['Longitude']
+		);
+		$this->zoomField->setValue(
+			$record['Zoom']
+		);
+		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());
+		return $this;
+	}
+
+	/**
+	 * @return FieldList The Latitude/Longitude fields
+	 */
+	public function getChildFields()
+	{
+		return $this->children;
+	}
+
+	protected function childFieldName($name)
+	{
+		$fieldNames = $this->getOption('field_names');
+		return $fieldNames[$name];
+	}
+
+	protected function recordFieldData($name)
+	{
+		$fieldName = $this->childFieldName($name);
+		return $this->data->$fieldName ?: $this->getDefaultValue($name);
+	}
+
+	public function getDefaultValue($name)
+	{
+		$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;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -92,19 +92,19 @@ 
 
         // Create the latitude/longitude hidden fields
         $this->latField = HiddenField::create(
-            $name.'[Latitude]',
+            $name . '[Latitude]',
             'Lat',
             $this->recordFieldData('Latitude')
         )->addExtraClass('googlemapfield-latfield');
 
         $this->lngField = HiddenField::create(
-            $name.'[Longitude]',
+            $name . '[Longitude]',
             'Lng',
             $this->recordFieldData('Longitude')
         )->addExtraClass('googlemapfield-lngfield');
 
         $this->zoomField = HiddenField::create(
-            $name.'[Zoom]',
+            $name . '[Zoom]',
             'Zoom',
             $this->recordFieldData('Zoom')
         )->addExtraClass('googlemapfield-zoomfield');
@@ -162,8 +162,8 @@ 
         if ($key = $this->getOption('api_key')) {
             $gmapsParams['key'] = $key;
         }
-        Requirements::css(GOOGLEMAPFIELD_BASE .'/css/GoogleMapField.css');
-        Requirements::javascript(GOOGLEMAPFIELD_BASE .'/javascript/GoogleMapField.js');
+        Requirements::css(GOOGLEMAPFIELD_BASE . '/css/GoogleMapField.css');
+        Requirements::javascript(GOOGLEMAPFIELD_BASE . '/javascript/GoogleMapField.js');
         Requirements::javascript('//maps.googleapis.com/maps/api/js?' . http_build_query($gmapsParams));
     }
 

Braces +17 added lines, -34 removed lines

@@ -9,8 +9,7 @@ 
  * Maps Geocoding API.
  * @author <@willmorgan>
  */
-class GoogleMapField extends FormField
-{
+class GoogleMapField extends FormField {
 
     protected $data;
 
@@ -40,8 +39,7 @@ 
      * @param string $title The title of the field
      * @param array $options Various settings for the field
      */
-    public function __construct(DataObject $data, $title, $options = array())
-    {
+    public function __construct(DataObject $data, $title, $options = array()) {
         $this->data = $data;
 
         // Set up fieldnames
@@ -53,8 +51,7 @@ 
     }
 
     // Auto generate a name
-    public function getName()
-    {
+    public function getName() {
         $fieldNames = $this->getOption('field_names');
         return sprintf(
             '%s_%s_%s',
@@ -68,8 +65,7 @@ 
      * Merge options preserving the first level of array keys
      * @param array $options
      */
-    public function setupOptions(array $options)
-    {
+    public function setupOptions(array $options) {
         $this->options = static::config()->default_options;
         foreach ($this->options as $name => &$value) {
             if (isset($options[$name])) {
@@ -86,8 +82,7 @@ 
      * Set up child hidden fields, and optionally the search box.
      * @return FieldList the children
      */
-    public function setupChildren()
-    {
+    public function setupChildren() {
         $name = $this->getName();
 
         // Create the latitude/longitude hidden fields
@@ -131,8 +126,7 @@ 
      * @see https://developers.google.com/maps/documentation/javascript/reference
      * {@inheritdoc}
      */
-    public function Field($properties = array())
-    {
+    public function Field($properties = array()) {
         $jsOptions = array(
             'coords' => array(
                 $this->recordFieldData('Latitude'),
@@ -154,8 +148,7 @@ 
      * Set up and include any frontend requirements
      * @return void
      */
-    protected function requireDependencies()
-    {
+    protected function requireDependencies() {
         $gmapsParams = array(
             'callback' => 'googlemapfieldInit',
         );
@@ -170,8 +163,7 @@ 
     /**
      * {@inheritdoc}
      */
-    public function setValue($record)
-    {
+    public function setValue($record) {
         $this->latField->setValue(
             $record['Latitude']
         );
@@ -188,8 +180,7 @@ 
      * Take the latitude/longitude fields and save them to the DataObject.
      * {@inheritdoc}
      */
-    public function saveInto(DataObjectInterface $record)
-    {
+    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());
@@ -199,25 +190,21 @@ 
     /**
      * @return FieldList The Latitude/Longitude fields
      */
-    public function getChildFields()
-    {
+    public function getChildFields() {
         return $this->children;
     }
 
-    protected function childFieldName($name)
-    {
+    protected function childFieldName($name) {
         $fieldNames = $this->getOption('field_names');
         return $fieldNames[$name];
     }
 
-    protected function recordFieldData($name)
-    {
+    protected function recordFieldData($name) {
         $fieldName = $this->childFieldName($name);
         return $this->data->$fieldName ?: $this->getDefaultValue($name);
     }
 
-    public function getDefaultValue($name)
-    {
+    public function getDefaultValue($name) {
         $fieldValues = $this->getOption('default_field_values');
         return isset($fieldValues[$name]) ? $fieldValues[$name] : null;
     }
@@ -225,8 +212,7 @@ 
     /**
      * @return string The VALUE of the Latitude field
      */
-    public function getLatData()
-    {
+    public function getLatData() {
         $fieldNames = $this->getOption('field_names');
         return $this->data->$fieldNames['Latitude'];
     }
@@ -234,8 +220,7 @@ 
     /**
      * @return string The VALUE of the Longitude field
      */
-    public function getLngData()
-    {
+    public function getLngData() {
         $fieldNames = $this->getOption('field_names');
         return $this->data->$fieldNames['Longitude'];
     }
@@ -245,8 +230,7 @@ 
      * @param string $name The name of the option
      * @return mixed
      */
-    public function getOption($name)
-    {
+    public function getOption($name) {
         // Quicker execution path for "."-free names
         if (strpos($name, '.') === false) {
             if (isset($this->options[$name])) {
@@ -274,8 +258,7 @@ 
      * @param mixed $val The value of said option
      * @return $this
      */
-    public function setOption($name, $val)
-    {
+    public function setOption($name, $val) {
         // Quicker execution path for "."-free names
         if (strpos($name, '.') === false) {
             $this->options[$name] = $val;