dynamic / silverstripe-locator

src/Model/Location.php

<?php

namespace Dynamic\Locator;

use Dynamic\Locator\Model\LocationCategory;
use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\ManyManyList;
use SilverStripe\Security\PermissionProvider;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\EmailField;
use SilverStripe\Security\Permission;
use Symbiote\GridFieldExtensions\GridFieldAddExistingSearchButton;

/**
 * Class Location
 *
 * @property string $Title
 * @property bool $Featured
 * @property string $Website
 * @property string $Phone
 * @property string $Email
 * @property string $EmailAddress
 * @property string $Fax
 * @property int $Import_ID
 *
 * @method ManyManyList Categories
 */
class Location extends DataObject implements PermissionProvider
{
    /**
     * @var string
     */
    private static $singular_name = 'Location';

The private property $singular_name is not used, and could be removed.

    /**
     * @var string
     */
    private static $plural_name = 'Locations';

The private property $plural_name is not used, and could be removed.

    /**
     * @var array
     */
    private static $db = [

The private property $db is not used, and could be removed.

        'Title' => 'Varchar(255)',
        'Featured' => 'Boolean',
        'Website' => 'Varchar(255)',
        'Phone' => 'Varchar(40)',
        'Email' => 'Varchar(255)',
        'Fax' => 'Varchar(45)',
        'Import_ID' => 'Int',
    ];

    private static $many_many = [

The private property $many_many is not used, and could be removed.

        'Categories' => LocationCategory::class,
    ];

    /**
     * @var string
     */
    private static $table_name = 'Location';

The private property $table_name is not used, and could be removed.

    /**
     * @var array
     */
    private static $casting = [

The private property $casting is not used, and could be removed.

        'distance' => 'Decimal(9,3)',
    ];

    /**
     * @var string
     */
    private static $default_sort = 'Title';

The private property $default_sort is not used, and could be removed.

    /**
     * api access via Restful Server module
     *
     * @var bool
     */
    private static $api_access = true;

The private property $api_access is not used, and could be removed.

    /**
     * search fields for Model Admin
     *
     * @var array
     */
    private static $searchable_fields = [

The private property $searchable_fields is not used, and could be removed.

        'Title',
        'Address',
        'City',
        'State',
        'PostalCode',
        'Country',
        'Website',
        'Phone',
        'Email',
        'Featured',
    ];

    /**
     * columns for grid field
     *
     * @var array
     */
    private static $summary_fields = [

The private property $summary_fields is not used, and could be removed.

        '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';

The property Lat does not exist on Dynamic\Locator\Location. Since you implemented __get, consider adding a @property annotation.

The property Lng does not exist on Dynamic\Locator\Location. Since you implemented __get, consider adding a @property annotation.

It seems like you are loosely comparing $this->Lng of type mixed|null to 0; this is ambiguous as not only 0 == 0 is true, but null == 0 is true, too. Consider using a strict comparison ===.

It seems like you are loosely comparing $this->Lat of type mixed|null to 0; this is ambiguous as not only 0 == 0 is true, but null == 0 is true, too. Consider using a strict comparison ===.

    }

    /**
     * @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) {

The property Country does not exist on Dynamic\Locator\Location. Since you implemented __get, consider adding a @property annotation.

            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

Are you sure the doc-type for parameter $member is correct as it would always require null to be passed?

     * @param array $context
     * @return bool
     */
    public function canView($member = null, $context = [])

The parameter $context is not used and could be removed.

    {
        return true;
    }

    /**
     * @param null $member

Are you sure the doc-type for parameter $member is correct as it would always require null to be passed?

     * @param array $context
     * @return bool|int
     */
    public function canEdit($member = null, $context = [])

The parameter $context is not used and could be removed.

    {
        return Permission::check('Location_EDIT', 'any', $member);
    }

    /**
     * @param null $member

Are you sure the doc-type for parameter $member is correct as it would always require null to be passed?

     * @param array $context
     * @return bool|int
     */
    public function canDelete($member = null, $context = [])

The parameter $context is not used and could be removed.

    {
        return Permission::check('Location_DELETE', 'any', $member);
    }

    /**
     * @param null $member

Are you sure the doc-type for parameter $member is correct as it would always require null to be passed?

     * @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;
    }
}