Merge pull request dynamic#141 from jsirish/feature/locationVersioning

Location - versioning

code/objects/Location.php

@@ -89,7 +89,6 @@ class Location extends DataObject implements PermissionProvider
         'Phone',
         'Email',
         'Category.ID',
-        'ShowInLocator',
         'Featured',
     );
 
@@ -106,11 +105,17 @@ class Location extends DataObject implements PermissionProvider
         'Postcode',
         'Country',
         'Category.Name',
-        'ShowInLocator.NiceAsBoolean',
         'Featured.NiceAsBoolean',
         'Coords',
     );
 
+    /**
+     * @var array
+     */
+    private static $extensions = [
+        'VersionedDataObject',
+    ];
+
     /**
      * Coords status for $summary_fields
      *
@@ -164,8 +169,6 @@ public function getCMSFields()
                         ->setAttribute('placeholder', 'http://'),
                     DropdownField::create('CategoryID', 'Category', LocationCategory::get()->map('ID', 'Title'))
                         ->setEmptyString('-- select --'),
-                    CheckboxField::create('ShowInLocator', 'Show in results')
-                        ->setDescription('Location will be included in results list'),
                     CheckboxField::create('Featured')
                         ->setDescription('Location will show at/near the top of the results list')
                 )
@@ -175,13 +178,14 @@ public function getCMSFields()
         // allow to be extended via DataExtension
         $this->extend('updateCMSFields', $fields);
 
+        $fields->removeByName([
+            'ShowInLocator',
+            'Import_ID',
+        ]);
+
         // override Suburb field name
         $fields->dataFieldByName('Suburb')->setTitle('City');
 
-        $fields->removeByName(array(
-            'Import_ID',
-        ));
-
         return $fields;
     }
 

code/pages/Locator.php

@@ -167,9 +167,7 @@ class Locator_Controller extends Page_Controller
     /**
      * @var array
      */
-    private static $base_filter = [
-        'ShowInLocator' => true,
-    ];
+    private static $base_filter = [];
 
     /**
      * @var array

composer.json

@@ -23,11 +23,12 @@
     "silverstripe/framework": "^3.4",
     "silverstripe/cms": "^3.4",
     "silverstripe-australia/addressable": "^1.1",
+    "heyday/silverstripe-versioneddataobjects": "^1.4",
+    "unclecheese/betterbuttons": "^1.3",
     "muskie9/data-to-arraylist": "^1.0",
     "silverstripe-australia/gridfieldextensions": "^1.2"
   },
   "suggest": {
-    "unclecheese/betterbuttons": "Adds new form actions and buttons to GridField detail form for usability enhancements.",
     "unclecheese/bootstrap-forms": "Allows the creation of forms compatible with the Twitter Bootstrap CSS framework in SilverStripe."
   },
   "extra": {

tasks/LocationPublishTask.php

@@ -0,0 +1,78 @@
+<?php
+
+/**
+ * Class LocationPublishTask
+ */
+class LocationPublishTask extends BuildTask
+{
+    /**
+     * @var string
+     */
+    protected $title = 'Publish all Locations';
+    /**
+     * @var string
+     */
+    protected $description = 'Migration task - pre versioning on Location';
+    /**
+     * @var bool
+     */
+    protected $enabled = true;
+
+    /**
+     * @param $request
+     */
+    public function run($request)
+    {
+        $class = ($request->getVar('locationclass')) ? $request->getVar('locationclass') : 'Location';
+        $this->publishLocations($class);
+    }
+
+    /**
+     * @param string $class
+     * @return Generator
+     */
+    protected function iterateLocations($class)
+    {
+        foreach ($class::get()->filter('ShowInLocator', true) as $location) {
+            yield $location;
+        }
+    }
+
+    /**
+     * mark all ProductDetail records as ShowInMenus = 0.
+     *
+     * @param string $class
+     */
+    public function publishLocations($class)
+    {
+        if (!isset($class) || !class_exists($class) || !$class instanceof Location) $class = 'Location';
+        $ct = 0;
+        $publish = function ($location) use (&$ct) {
+            if (!$location->isPublished()) {
+                $title = $location->Title;
+                $location->writeToStage('Stage');
+                $location->publish('Stage', 'Live');
+                static::write_message($title);
+                ++$ct;
+            }
+        };
+
+        foreach ($this->iterateLocations($class) as $location) {
+            $publish($location);
+        }
+
+        static::write_message("{$ct} locations updated.");
+    }
+
+    /**
+     * @param $message
+     */
+    protected static function write_message($message)
+    {
+        if (Director::is_cli()) {
+            echo "{$message}\n";
+        } else {
+            echo "{$message}<br><br>";
+        }
+    }
+}

tests/LocationTest.php

@@ -53,6 +53,8 @@ public function testFieldLabels()
             'Coords' => 'Coords',
             'Import_ID' => 'Import_ID',
             'LatLngOverride' => 'Lat Lng Override',
+            'Version' => 'Version',
+            'Versions' => 'Versions'
         );
         $this->assertEquals($expected, $labels);
     }