dynamic / silverstripe-locator

src/objects/Location.php

Indentation +252 added lines, -252 removed lines

@@ -28,256 +28,256 @@
  */
 class Location extends DataObject implements PermissionProvider
 {
-    /**
-     * @var string
-     */
-    private static $singular_name = 'Location';
-
-    /**
-     * @var string
-     */
-    private static $plural_name = 'Locations';
-
-    /**
-     * @var array
-     */
-    private static $db = [
-        'Title' => 'Varchar(255)',
-        'Featured' => 'Boolean',
-        'Website' => 'Varchar(255)',
-        'Phone' => 'Varchar(40)',
-        'Email' => 'Varchar(255)',
-        'Fax' => 'Varchar(45)',
-        'Import_ID' => 'Int',
-    ];
-
-    private static $many_many = [
-        'Categories' => LocationCategory::class,
-    ];
-
-    /**
-     * @var string
-     */
-    private static $table_name = 'Location';
-
-    /**
-     * @var array
-     */
-    private static $casting = [
-        'distance' => 'Decimal(9,3)',
-    ];
-
-    /**
-     * @var string
-     */
-    private static $default_sort = 'Title';
-
-    /**
-     * api access via Restful Server module
-     *
-     * @var bool
-     */
-    private static $api_access = true;
-
-    /**
-     * search fields for Model Admin
-     *
-     * @var array
-     */
-    private static $searchable_fields = [
-        'Title',
-        'Address',
-        'City',
-        'State',
-        'PostalCode',
-        'Country',
-        'Website',
-        'Phone',
-        'Email',
-        'Featured',
-    ];
-
-    /**
-     * columns for grid field
-     *
-     * @var array
-     */
-    private static $summary_fields = [
-        'Title',
-        'Address',
-        'Address2',
-        'City',
-        'State',
-        'PostalCode',
-        'CountryCode',
-        'Phone' => 'Phone',
-        'Fax' => 'Fax',
-        'Email' => 'Email',
-        'Website' => 'Website',
-        'Featured',
-        'CategoryList',
-        'Lat',
-        'Lng',
-        'Import_ID',
-    ];
-
-    /**
-     * Coords status for $summary_fields
-     *
-     * @return string
-     */
-    public function getCoords()
-    {
-        return ($this->Lat != 0 && $this->Lng != 0) ? 'true' : 'false';
-    }
-
-    /**
-     * @return string
-     */
-    public function getCategoryList()
-    {
-        if ($this->Categories()->count()) {
-            return implode(', ', $this->Categories()->column('Name'));
-        }
-
-        return '';
-    }
-
-    /**
-     * @return bool|string
-     */
-    public function getCountryCode()
-    {
-        if ($this->Country) {
-            return strtoupper($this->Country);
-        }
-
-        return false;
-    }
-
-    /**
-     * custom labels for fields
-     *
-     * @param bool $includerelations
-     * @return array|string
-     */
-    public function fieldLabels($includerelations = true)
-    {
-        $labels = parent::fieldLabels($includerelations);
-        $labels['Title'] = 'Name';
-        $labels['Address2'] = 'Address 2';
-        $labels['PostalCode'] = 'Postal Code';
-        $labels['Categories.Name'] = 'Categories';
-        $labels['Featured.NiceAsBoolean'] = 'Featured';
-
-        return $labels;
-    }
-
-    /**
-     * @return FieldList
-     */
-    public function getCMSFields()
-    {
-        $this->beforeUpdateCMSFields(function ($fields) {
-            $fields->removeByName([
-                'Import_ID',
-                'LinkTracking',
-                'FileTracking',
-            ]);
-
-            $fields->dataFieldByName('Website')
-                ->setAttribute('placeholder', 'http://');
-
-            $fields->replaceField('Email', EmailField::create('Email'));
-
-            $featured = $fields->dataFieldByName('Featured')
-                ->setDescription('Location will display near the top of the results list');
-            $fields->insertAfter(
-                'Fax',
-                $featured
-            );
-
-            if ($this->ID) {
-                $categories = $fields->dataFieldByName('Categories');
-                $config = $categories->getConfig();
-                $config->removeComponentsByType([
-                    GridFieldAddExistingAutocompleter::class,
-                ])
-                    ->addComponents([
-                        new GridFieldAddExistingSearchButton(),
-                    ]);
-            }
-        });
-
-        $fields = parent::getCMSFields();
-
-        // allow to be extended via DataExtension
-        $this->extend('updateLocationFields', $fields);
-
-        return $fields;
-    }
-
-    /**
-     * @param null $member
-     * @param array $context
-     * @return bool
-     */
-    public function canView($member = null, $context = [])
-    {
-        return true;
-    }
-
-    /**
-     * @param null $member
-     * @param array $context
-     * @return bool|int
-     */
-    public function canEdit($member = null, $context = [])
-    {
-        return Permission::check('Location_EDIT', 'any', $member);
-    }
-
-    /**
-     * @param null $member
-     * @param array $context
-     * @return bool|int
-     */
-    public function canDelete($member = null, $context = [])
-    {
-        return Permission::check('Location_DELETE', 'any', $member);
-    }
-
-    /**
-     * @param null $member
-     * @param array $context
-     * @return bool|int
-     */
-    public function canCreate($member = null, $context = [])
-    {
-        return Permission::check('Location_CREATE', 'any', $member);
-    }
-
-    /**
-     * @return array
-     */
-    public function providePermissions()
-    {
-        return [
-            'Location_EDIT' => 'Edit a Location',
-            'Location_DELETE' => 'Delete a Location',
-            'Location_CREATE' => 'Create a Location',
-        ];
-    }
-
-    /**
-     * @return string
-     */
-    public function getWebsiteURL()
-    {
-        $url = $this->Website;
-
-        $this->extend('updateWebsiteURL', $url);
-
-        return $url;
-    }
+	/**
+	 * @var string
+	 */
+	private static $singular_name = 'Location';
+
+	/**
+	 * @var string
+	 */
+	private static $plural_name = 'Locations';
+
+	/**
+	 * @var array
+	 */
+	private static $db = [
+		'Title' => 'Varchar(255)',
+		'Featured' => 'Boolean',
+		'Website' => 'Varchar(255)',
+		'Phone' => 'Varchar(40)',
+		'Email' => 'Varchar(255)',
+		'Fax' => 'Varchar(45)',
+		'Import_ID' => 'Int',
+	];
+
+	private static $many_many = [
+		'Categories' => LocationCategory::class,
+	];
+
+	/**
+	 * @var string
+	 */
+	private static $table_name = 'Location';
+
+	/**
+	 * @var array
+	 */
+	private static $casting = [
+		'distance' => 'Decimal(9,3)',
+	];
+
+	/**
+	 * @var string
+	 */
+	private static $default_sort = 'Title';
+
+	/**
+	 * api access via Restful Server module
+	 *
+	 * @var bool
+	 */
+	private static $api_access = true;
+
+	/**
+	 * search fields for Model Admin
+	 *
+	 * @var array
+	 */
+	private static $searchable_fields = [
+		'Title',
+		'Address',
+		'City',
+		'State',
+		'PostalCode',
+		'Country',
+		'Website',
+		'Phone',
+		'Email',
+		'Featured',
+	];
+
+	/**
+	 * columns for grid field
+	 *
+	 * @var array
+	 */
+	private static $summary_fields = [
+		'Title',
+		'Address',
+		'Address2',
+		'City',
+		'State',
+		'PostalCode',
+		'CountryCode',
+		'Phone' => 'Phone',
+		'Fax' => 'Fax',
+		'Email' => 'Email',
+		'Website' => 'Website',
+		'Featured',
+		'CategoryList',
+		'Lat',
+		'Lng',
+		'Import_ID',
+	];
+
+	/**
+	 * Coords status for $summary_fields
+	 *
+	 * @return string
+	 */
+	public function getCoords()
+	{
+		return ($this->Lat != 0 && $this->Lng != 0) ? 'true' : 'false';
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getCategoryList()
+	{
+		if ($this->Categories()->count()) {
+			return implode(', ', $this->Categories()->column('Name'));
+		}
+
+		return '';
+	}
+
+	/**
+	 * @return bool|string
+	 */
+	public function getCountryCode()
+	{
+		if ($this->Country) {
+			return strtoupper($this->Country);
+		}
+
+		return false;
+	}
+
+	/**
+	 * custom labels for fields
+	 *
+	 * @param bool $includerelations
+	 * @return array|string
+	 */
+	public function fieldLabels($includerelations = true)
+	{
+		$labels = parent::fieldLabels($includerelations);
+		$labels['Title'] = 'Name';
+		$labels['Address2'] = 'Address 2';
+		$labels['PostalCode'] = 'Postal Code';
+		$labels['Categories.Name'] = 'Categories';
+		$labels['Featured.NiceAsBoolean'] = 'Featured';
+
+		return $labels;
+	}
+
+	/**
+	 * @return FieldList
+	 */
+	public function getCMSFields()
+	{
+		$this->beforeUpdateCMSFields(function ($fields) {
+			$fields->removeByName([
+				'Import_ID',
+				'LinkTracking',
+				'FileTracking',
+			]);
+
+			$fields->dataFieldByName('Website')
+				->setAttribute('placeholder', 'http://');
+
+			$fields->replaceField('Email', EmailField::create('Email'));
+
+			$featured = $fields->dataFieldByName('Featured')
+				->setDescription('Location will display near the top of the results list');
+			$fields->insertAfter(
+				'Fax',
+				$featured
+			);
+
+			if ($this->ID) {
+				$categories = $fields->dataFieldByName('Categories');
+				$config = $categories->getConfig();
+				$config->removeComponentsByType([
+					GridFieldAddExistingAutocompleter::class,
+				])
+					->addComponents([
+						new GridFieldAddExistingSearchButton(),
+					]);
+			}
+		});
+
+		$fields = parent::getCMSFields();
+
+		// allow to be extended via DataExtension
+		$this->extend('updateLocationFields', $fields);
+
+		return $fields;
+	}
+
+	/**
+	 * @param null $member
+	 * @param array $context
+	 * @return bool
+	 */
+	public function canView($member = null, $context = [])
+	{
+		return true;
+	}
+
+	/**
+	 * @param null $member
+	 * @param array $context
+	 * @return bool|int
+	 */
+	public function canEdit($member = null, $context = [])
+	{
+		return Permission::check('Location_EDIT', 'any', $member);
+	}
+
+	/**
+	 * @param null $member
+	 * @param array $context
+	 * @return bool|int
+	 */
+	public function canDelete($member = null, $context = [])
+	{
+		return Permission::check('Location_DELETE', 'any', $member);
+	}
+
+	/**
+	 * @param null $member
+	 * @param array $context
+	 * @return bool|int
+	 */
+	public function canCreate($member = null, $context = [])
+	{
+		return Permission::check('Location_CREATE', 'any', $member);
+	}
+
+	/**
+	 * @return array
+	 */
+	public function providePermissions()
+	{
+		return [
+			'Location_EDIT' => 'Edit a Location',
+			'Location_DELETE' => 'Delete a Location',
+			'Location_CREATE' => 'Create a Location',
+		];
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getWebsiteURL()
+	{
+		$url = $this->Website;
+
+		$this->extend('updateWebsiteURL', $url);
+
+		return $url;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -178,7 +178,7 @@
      */
     public function getCMSFields()
     {
-        $this->beforeUpdateCMSFields(function ($fields) {
+        $this->beforeUpdateCMSFields(function($fields) {
             $fields->removeByName([
                 'Import_ID',
                 'LinkTracking',

tests/Extension/LocationExtension.php

Indentation +8 added lines, -8 removed lines

@@ -11,12 +11,12 @@
  */
 class LocationExtension extends DataExtension implements TestOnly
 {
-    /**
-     * @param $url
-     * @return string
-     */
-    public function updateWebsiteURL(&$url)
-    {
-        $url = 'foo';
-    }
+	/**
+	 * @param $url
+	 * @return string
+	 */
+	public function updateWebsiteURL(&$url)
+	{
+		$url = 'foo';
+	}
 }

tests/Model/ExtendedLocation.php

Indentation +6 added lines, -6 removed lines

@@ -12,10 +12,10 @@
  */
 class ExtendedLocation extends Location implements TestOnly
 {
-    /**
-     * @var array
-     */
-    private static $extensions = [
-        LocationExtension::class,
-    ];
+	/**
+	 * @var array
+	 */
+	private static $extensions = [
+		LocationExtension::class,
+	];
 }

tests/objects/LocationTest.php

Indentation +202 added lines, -202 removed lines

@@ -18,206 +18,206 @@
  */
 class LocationTest extends SapphireTest
 {
-    /**
-     * @var string
-     */
-    protected static $fixture_file = '../fixtures.yml';
-
-    /**
-     * @var array
-     */
-    protected static $extra_dataobjects = [
-        ExtendedLocation::class,
-    ];
-
-    /**
-     * @var array
-     */
-    protected static $required_extensions = [
-        ExtendedLocation::class => [
-            LocationExtension::class,
-        ],
-    ];
-
-    /**
-     *
-     */
-    public function testGetCoords()
-    {
-        $location = $this->objFromFixture(Location::class, 'dynamic');
-        $coords = ((int)$location->Lat != 0 && (int)$location->Lng != 0) ? 'true' : 'false';
-        $this->assertEquals($coords, $location->getCoords());
-    }
-
-    /**
-     *
-     */
-    public function testFieldLabels()
-    {
-        $this->markTestSkipped();
-        // Link and File tracking display as "Tracking" in SS 4.2 & 4.3, "Tracking" in 4.4
-        $location = $this->objFromFixture(Location::class, 'dynamic');
-        $labels = $location->FieldLabels();
-        $expected = [
-            'Title' => 'Name',
-            'Featured' => 'Featured',
-            'Website' => 'Website',
-            'Phone' => 'Phone',
-            'Email' => 'Email',
-            'Fax' => 'Fax',
-            'Address' => 'Address',
-            'City' => 'City',
-            'State' => 'State',
-            'PostalCode' => 'Postal Code',
-            'Country' => 'Country',
-            'Lat' => 'Lat',
-            'Lng' => 'Lng',
-            'Categories' => 'Categories',
-            'Category.Name' => 'Category',
-            'Category.ID' => 'Category',
-            'Featured.NiceAsBoolean' => 'Featured',
-            'Import_ID' => 'Import_ID',
-            'Version' => 'Version',
-            'Versions' => 'Versions',
-            'Address2' => 'Address2',
-            'LinkTracking' => 'Link tracking',
-            'FileTracking' => 'File tracking',
-        ];
-        $this->assertEquals($expected, $labels);
-    }
-
-    /**
-     *
-     */
-    public function testGetCMSFields()
-    {
-        $object = new Location();
-        $fieldset = $object->getCMSFields();
-        $this->assertinstanceOf(FieldList::class, $fieldset);
-    }
-
-    /**
-     *
-     */
-    public function testCanView()
-    {
-        $object = $this->objFromFixture(Location::class, 'dynamic');
-        $object->write();
-
-        $this->assertTrue($object->canView());
-
-        $nullMember = Member::create();
-        $nullMember->write();
-
-        $this->assertTrue($object->canView($nullMember));
-
-        $nullMember->delete();
-    }
-
-    /**
-     *
-     */
-    public function testCanEdit()
-    {
-        $object = $this->objFromFixture(Location::class, 'dynamic');
-        $object->write();
-
-        $objectID = $object->ID;
-
-        //test permissions per permission setting
-        $create = $this->objFromFixture(Member::class, 'locationcreate');
-        $edit = $this->objFromFixture(Member::class, 'locationedit');
-        $delete = $this->objFromFixture(Member::class, 'locationdelete');
-
-        $originalTitle = $object->Title;
-        $this->assertEquals($originalTitle, 'Dynamic, Inc.');
-
-        $this->assertTrue($object->canEdit($edit));
-        $this->assertFalse($object->canEdit($create));
-        $this->assertFalse($object->canEdit($delete));
-
-        $object->Title = 'Changed Title';
-        $object->write();
-
-        $testEdit = Location::get()->byID($objectID);
-        $this->assertEquals($testEdit->Title, 'Changed Title');
-    }
-
-    /**
-     *
-     */
-    public function testCanDelete()
-    {
-        $object = $this->objFromFixture(Location::class, 'dynamic');
-        $object->write();
-
-        //test permissions per permission setting
-        $create = $this->objFromFixture(Member::class, 'locationcreate');
-        $edit = $this->objFromFixture(Member::class, 'locationedit');
-        $delete = $this->objFromFixture(Member::class, 'locationdelete');
-
-        $this->assertTrue($object->canDelete($delete));
-        $this->assertFalse($object->canDelete($create));
-        $this->assertFalse($object->canDelete($edit));
-
-        $checkObject = $object;
-        $object->delete();
-
-        $this->assertEquals($checkObject->ID, 0);
-    }
-
-    /**
-     *
-     */
-    public function testCanCreate()
-    {
-        $object = singleton(Location::class);
-
-        //test permissions per permission setting
-        $create = $this->objFromFixture(Member::class, 'locationcreate');
-        $edit = $this->objFromFixture(Member::class, 'locationedit');
-        $delete = $this->objFromFixture(Member::class, 'locationdelete');
-
-        $this->assertTrue($object->canCreate($create));
-        $this->assertFalse($object->canCreate($edit));
-        $this->assertFalse($object->canCreate($delete));
-
-        $nullMember = Member::create();
-        $nullMember->write();
-        $this->assertFalse($object->canCreate($nullMember));
-
-        $nullMember->delete();
-    }
-
-    /**
-     *
-     */
-    public function testProvidePermissions()
-    {
-        $object = Location::create();
-        $expected = [
-            'Location_EDIT' => 'Edit a Location',
-            'Location_DELETE' => 'Delete a Location',
-            'Location_CREATE' => 'Create a Location',
-        ];
-        $this->assertEquals($expected, $object->providePermissions());
-    }
-
-    /**
-     *
-     */
-    public function testUpdateWebsiteURL()
-    {
-        $location = $this->objFromFixture(Location::class, 'dynamic');
-
-        // Create unsaved raw duplicate
-        $map = $location->toMap();
-        unset($map['Created']);
-        /** @var static $clone */
-        $clone = Injector::inst()->create(ExtendedLocation::class, $map);
-        $clone->ID = 0;
-
-        $this->assertEquals('http://www.dynamicagency.com', $location->getWebsiteURL());
-        $this->assertEquals('foo', $clone->getWebsiteURL());
-    }
+	/**
+	 * @var string
+	 */
+	protected static $fixture_file = '../fixtures.yml';
+
+	/**
+	 * @var array
+	 */
+	protected static $extra_dataobjects = [
+		ExtendedLocation::class,
+	];
+
+	/**
+	 * @var array
+	 */
+	protected static $required_extensions = [
+		ExtendedLocation::class => [
+			LocationExtension::class,
+		],
+	];
+
+	/**
+	 *
+	 */
+	public function testGetCoords()
+	{
+		$location = $this->objFromFixture(Location::class, 'dynamic');
+		$coords = ((int)$location->Lat != 0 && (int)$location->Lng != 0) ? 'true' : 'false';
+		$this->assertEquals($coords, $location->getCoords());
+	}
+
+	/**
+	 *
+	 */
+	public function testFieldLabels()
+	{
+		$this->markTestSkipped();
+		// Link and File tracking display as "Tracking" in SS 4.2 & 4.3, "Tracking" in 4.4
+		$location = $this->objFromFixture(Location::class, 'dynamic');
+		$labels = $location->FieldLabels();
+		$expected = [
+			'Title' => 'Name',
+			'Featured' => 'Featured',
+			'Website' => 'Website',
+			'Phone' => 'Phone',
+			'Email' => 'Email',
+			'Fax' => 'Fax',
+			'Address' => 'Address',
+			'City' => 'City',
+			'State' => 'State',
+			'PostalCode' => 'Postal Code',
+			'Country' => 'Country',
+			'Lat' => 'Lat',
+			'Lng' => 'Lng',
+			'Categories' => 'Categories',
+			'Category.Name' => 'Category',
+			'Category.ID' => 'Category',
+			'Featured.NiceAsBoolean' => 'Featured',
+			'Import_ID' => 'Import_ID',
+			'Version' => 'Version',
+			'Versions' => 'Versions',
+			'Address2' => 'Address2',
+			'LinkTracking' => 'Link tracking',
+			'FileTracking' => 'File tracking',
+		];
+		$this->assertEquals($expected, $labels);
+	}
+
+	/**
+	 *
+	 */
+	public function testGetCMSFields()
+	{
+		$object = new Location();
+		$fieldset = $object->getCMSFields();
+		$this->assertinstanceOf(FieldList::class, $fieldset);
+	}
+
+	/**
+	 *
+	 */
+	public function testCanView()
+	{
+		$object = $this->objFromFixture(Location::class, 'dynamic');
+		$object->write();
+
+		$this->assertTrue($object->canView());
+
+		$nullMember = Member::create();
+		$nullMember->write();
+
+		$this->assertTrue($object->canView($nullMember));
+
+		$nullMember->delete();
+	}
+
+	/**
+	 *
+	 */
+	public function testCanEdit()
+	{
+		$object = $this->objFromFixture(Location::class, 'dynamic');
+		$object->write();
+
+		$objectID = $object->ID;
+
+		//test permissions per permission setting
+		$create = $this->objFromFixture(Member::class, 'locationcreate');
+		$edit = $this->objFromFixture(Member::class, 'locationedit');
+		$delete = $this->objFromFixture(Member::class, 'locationdelete');
+
+		$originalTitle = $object->Title;
+		$this->assertEquals($originalTitle, 'Dynamic, Inc.');
+
+		$this->assertTrue($object->canEdit($edit));
+		$this->assertFalse($object->canEdit($create));
+		$this->assertFalse($object->canEdit($delete));
+
+		$object->Title = 'Changed Title';
+		$object->write();
+
+		$testEdit = Location::get()->byID($objectID);
+		$this->assertEquals($testEdit->Title, 'Changed Title');
+	}
+
+	/**
+	 *
+	 */
+	public function testCanDelete()
+	{
+		$object = $this->objFromFixture(Location::class, 'dynamic');
+		$object->write();
+
+		//test permissions per permission setting
+		$create = $this->objFromFixture(Member::class, 'locationcreate');
+		$edit = $this->objFromFixture(Member::class, 'locationedit');
+		$delete = $this->objFromFixture(Member::class, 'locationdelete');
+
+		$this->assertTrue($object->canDelete($delete));
+		$this->assertFalse($object->canDelete($create));
+		$this->assertFalse($object->canDelete($edit));
+
+		$checkObject = $object;
+		$object->delete();
+
+		$this->assertEquals($checkObject->ID, 0);
+	}
+
+	/**
+	 *
+	 */
+	public function testCanCreate()
+	{
+		$object = singleton(Location::class);
+
+		//test permissions per permission setting
+		$create = $this->objFromFixture(Member::class, 'locationcreate');
+		$edit = $this->objFromFixture(Member::class, 'locationedit');
+		$delete = $this->objFromFixture(Member::class, 'locationdelete');
+
+		$this->assertTrue($object->canCreate($create));
+		$this->assertFalse($object->canCreate($edit));
+		$this->assertFalse($object->canCreate($delete));
+
+		$nullMember = Member::create();
+		$nullMember->write();
+		$this->assertFalse($object->canCreate($nullMember));
+
+		$nullMember->delete();
+	}
+
+	/**
+	 *
+	 */
+	public function testProvidePermissions()
+	{
+		$object = Location::create();
+		$expected = [
+			'Location_EDIT' => 'Edit a Location',
+			'Location_DELETE' => 'Delete a Location',
+			'Location_CREATE' => 'Create a Location',
+		];
+		$this->assertEquals($expected, $object->providePermissions());
+	}
+
+	/**
+	 *
+	 */
+	public function testUpdateWebsiteURL()
+	{
+		$location = $this->objFromFixture(Location::class, 'dynamic');
+
+		// Create unsaved raw duplicate
+		$map = $location->toMap();
+		unset($map['Created']);
+		/** @var static $clone */
+		$clone = Injector::inst()->create(ExtendedLocation::class, $map);
+		$clone->ID = 0;
+
+		$this->assertEquals('http://www.dynamicagency.com', $location->getWebsiteURL());
+		$this->assertEquals('foo', $clone->getWebsiteURL());
+	}
 }