dynamic / silverstripe-locator

src/Page/LocationPage.php

<?php

namespace Dynamic\Locator\Page;

use Dynamic\Locator\Model\LocationCategory;
use SilverStripe\Forms\CheckboxField;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
use SilverStripe\Forms\GridField\GridFieldConfig_RelationEditor;
use SilverStripe\Forms\TextField;
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 LocationPage extends \Page 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.

        'Featured' => 'Boolean',
        'Website' => 'Varchar(255)',
        'Phone' => 'Varchar(40)',
        'Email' => 'Varchar(255)',
        'Fax' => 'Varchar(45)',
        'Import_ID' => 'Int',
        'LegacyObjectID' => '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 = 'LocationPage';

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 int[]
     */
    private static $defaults = [

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

        'ShowInMenus' => 0,
    ];

    /**
     * @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',
    ];

    /**
     * @var bool
     */
    private static $show_in_sitetree = false;

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

    /**
     * @var array
     */
    private static $allowed_children = [];

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

    /**
     * Coords status for $summary_fields
     *
     * @return string
     */
    public function getCoords()
    {
        return ($this->Lat != 0 && $this->Lng != 0) ? 'true' : 'false';

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 ===.

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

The property Lng does not exist on Dynamic\Locator\Page\LocationPage. 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 ===.

    }

    /**
     * @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\Page\LocationPage. 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 (FieldList $fields) {
            $fields->addFieldsToTab(
                'Root.Main',
                [
                    CheckboxField::create('Featured')
                        ->setTitle('Featured'),
                ],
                'Content'
            );

            if ($this->exists()) {
                $fields->addFieldToTab(
                    'Root.Categories',
                    GridField::create(
                        'Categories',
                        'Categories',
                        $this->Categories(),
                        $catConfig = GridFieldConfig_RelationEditor::create()
                    )
                );

                $catConfig->removeComponentsByType([
                    GridFieldAddExistingAutocompleter::class,
                ])->addComponents([
                    new GridFieldAddExistingSearchButton()
                ]);
            }

            $fields->addFieldsToTab('Root.Contact', [
                TextField::create('Website')
                    ->setTitle('Website')
                    ->setDescription('Include the http/https (example: https://google.com)'),
                TextField::create('Phone')
                    ->setTitle('Phone'),
                EmailField::create('Email')
                    ->setTitle('Email'),
                TextField::create('Fax')
                    ->setTitle('Fax'),
            ]);
        });

        return parent::getCMSFields();
    }

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

        if ($url && !preg_match('/^(http|https):\/\//', $url)) {
            $url = 'http://' . $url;
        }

        $this->extend('updateWebsiteURL', $url);

        return $url;
    }
}