NEW Add fieldPrefix and document multiple use case

Author: wilr

README.md

@@ -65,20 +65,49 @@ use SilverStripe\ORM\DataObject;
 
 class AddressObject extends DataObject
 {
-	private static $db = [
-		'Address' => 'Text',
-		'PostalLine1' => 'Varchar(200)',
-		'PostalLine2' => 'Varchar(200)',
-		'PostalLine3' => 'Varchar(200)',
-		'PostalLine4' => 'Varchar(200)',
-		'PostalLine5' => 'Varchar(200)',
-		'PostalLine6' => 'Varchar(200)',
-		'Suburb' => 'Varchar(200)',
-		'City' => 'Varchar(200)',
-		'Postcode' => 'Varchar(200)',
-		'Latitude' => 'Varchar(200)',
-		'Longitude' => 'Varchar(200)'
-	];
+    private static $db = [
+        'Address' => 'Text',
+        'PostalLine1' => 'Varchar(200)',
+        'PostalLine2' => 'Varchar(200)',
+        'PostalLine3' => 'Varchar(200)',
+        'PostalLine4' => 'Varchar(200)',
+        'PostalLine5' => 'Varchar(200)',
+        'PostalLine6' => 'Varchar(200)',
+        'Suburb' => 'Varchar(200)',
+        'City' => 'Varchar(200)',
+        'Postcode' => 'Varchar(200)',
+        'Latitude' => 'Varchar(200)',
+        'Longitude' => 'Varchar(200)'
+    ];
 }
 ```
 
+To prefix these fields, call `setFieldPrefix($prefix)`  on your
+`AddressFinderField` instance.
+
+```php
+AddressFinderField::create('HomeAddress')
+    ->setFieldPrefix('Home')
+AddressFinderField::create('WorkAddress')
+    ->setFieldPrefix('Work')
+
+// requires the following model
+private static $db = [
+    'HomeAddress' => 'Text',
+    'HomeAddressPostalLine1' => 'Varchar(200)',
+    'HomeAddressPostalLine2' => 'Varchar(200)',
+    'HomeAddressPostalLine3' => 'Varchar(200)',
+    'HomeAddressPostalLine4' => 'Varchar(200)',
+    'HomeAddressPostalLine5' => 'Varchar(200)',
+    'HomeAddressPostalLine6' => 'Varchar(200)',
+    'HomeAddressSuburb' => 'Varchar(200)',
+    'HomeAddressCity' => 'Varchar(200)',
+    'HomeAddressPostcode' => 'Varchar(200)',
+    'HomeAddressLatitude' => 'Varchar(200)',
+    'HomeAddressLongitude' => 'Varchar(200)',
+    'WorkAddress' => 'Text',
+    'WorkAddressPostalLine1' => 'Varchar(200)',
+    'WorkAddressPostalLine2' => 'Varchar(200)',
+    //...
+];
+```

src/AddressFinderField.php

@@ -47,6 +47,11 @@ class AddressFinderField extends TextField
      */
     protected $manualToggle;
 
+    /**
+     * @var string
+     */
+    protected $fieldPrefix = '';
+
     /**
      * @var boolean
      */
@@ -333,7 +338,7 @@ public function setValue($value, $record = null)
 
             if ($this->getShowManualFields()) {
                 foreach ($this->getManualFields() as $field) {
-                    $nested = $this->getNestedFieldName($field);
+                    $nested = $this->getNestedFieldName($field, false);
 
                     if (isset($value[$nested])) {
                         $field->setValue($value[$nested]);
@@ -380,7 +385,7 @@ public function dataValue()
 
         if ($this->getShowManualFields()) {
             foreach ($this->getManualFields() as $field) {
-                $fieldName = $this->getNestedFieldName($field);
+                $fieldName = $this->getNestedFieldName($field, false);
                 $data[$fieldName] = $field->Value();
             }
         }
@@ -394,12 +399,34 @@ public function dataValue()
      * field.
      *
      * @param FormField $field
+     * @param bool $prefixName
      *
      * @return string
      */
-    protected function getNestedFieldName($field)
+    protected function getNestedFieldName($field, $prefixName = true)
     {
-        return substr($field->getName(), strlen($this->getName()) + 1, -1);
+        $name = substr($field->getName(), strlen($this->getName()) + 1, -1);
+
+        if ($this->fieldPrefix && $prefixName) {
+            return $this->fieldPrefix . $name;
+        }
+
+        return $name;
+    }
+
+    /**
+     * Set a prefix for the data fields if required. For instance, without a
+     * prefix this field save the 'Postcode' as $record->Postcode, if you need
+     * to have multiple addresses (i.e Home, Work) or would prefer to have all
+     * the address info under a prefix then define one here
+     *
+     * setFieldPrefix('Work'); // $record->WorkPostcode = 1234;
+     */
+    public function setFieldPrefix($prefix)
+    {
+        $this->fieldPrefix = $prefix;
+
+        return $this;
     }
 
     /**
@@ -414,7 +441,7 @@ public function setName($name)
         $this->addressField->setName("{$name}[Address]");
 
         foreach ($this->getManualFields() as $field) {
-            $nested = $this->getNestedFieldName($field);
+            $nested = $this->getNestedFieldName($field, false);
 
             $field->setName("{$name}[{$nested}]");
         }