Location::canView() - Code Metrics - Inspection of "Front end uses react and redux" - dynamic/silverstripe-locator - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#173)

by Matthew
created 2017-10-27 13:47 UTC
Location::canView() A

↳ Parent: Location
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	2
dl	0
loc	3
rs	10
<?php

namespace Dynamic\Locator;

use SilverStripe\ORM\DataObject;
use SilverStripe\Security\PermissionProvider;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\EmailField;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Security\Permission;

/**
 * Class Location
 *
 * @property string $Title
 * @property bool $Featured
 * @property string $Website
 * @property string $Phone
 * @property string $Email
 * @property string $EmailAddress
 * @property int $Import_ID
 * @property int $CategoryID
 * @method LocationCategory $Category
 */
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 = array(
        'Title' => 'Varchar(255)',
        'Featured' => 'Boolean',
        'Website' => 'Varchar(255)',
        'Phone' => 'Varchar(40)',
        'Email' => 'Varchar(255)',
        'Import_ID' => 'Int',
    );

    /**
     * @var array
     */
    private static $has_one = array(
        'Category' => LocationCategory::class,
    );

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


    /**
     * @var array
     */
    private static $casting = array(
        '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 = array(
        'Title',
        'Address',
        'City',
        'State',
        'PostalCode',
        'Country',
        'Website',
        'Phone',
        'Email',
        'Category.ID',
        'Featured',
    );

    /**
     * columns for grid field
     *
     * @var array
     */
    private static $summary_fields = array(
        'Title',
        'Address',
        'City',
        'State',
        'PostalCode',
        'Country',
        'Category.Name',
        'Featured.NiceAsBoolean',
        'Coords',
    );

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

    }

    /**
     * custom labels for fields
     *
     * @param bool $includerelations
     *
     * @return array|string
     */
    public function fieldLabels($includerelations = true)
    {
        $labels = parent::fieldLabels($includerelations);
        $labels['Title'] = 'Name';
        $labels['PostalCode'] = 'Postal Code';
        $labels['Category.Name'] = 'Category';
        $labels['Category.ID'] = 'Category';
        $labels['Featured.NiceAsBoolean'] = 'Featured';

        return $labels;
    }

    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        // so it can easily be extended - concept taken from the blog module
        $this->beforeUpdateCMSFields(function ($fields) {
            $fields->removeByName(array(
                'Import_ID',
            ));

            $fields->dataFieldByName('Website')
                   ->setAttribute('placeholder', 'http://');

            $fields->replaceField('Email', EmailField::create('Email'));
            $fields->replaceField('Email', EmailField::create(/** @scrutinizer ignore-type */ 'Email'));

            $fields->replaceField(
                'CategoryID',
                DropdownField::create('CategoryID', 'Category', LocationCategory::get()->map())->setEmptyString('')
                DropdownField::create('CategoryID', 'Category', /** @scrutinizer ignore-type */ LocationCategory::get()->map())->setEmptyString('')
            );

            $featured = $fields->dataFieldByName('Featured')
                               ->setDescription('Location will display near the top of the results list');
            $fields->insertAfter(
                $featured,
                'CategoryID'
            );
        });

        return parent::getCMSFields();
    }

    /**
     * @param null $member

     * @param array $context
     *
     * @return bool
     */
    public function canView($member = null, $context = [])
    public function canView($member = null, /** @scrutinizer ignore-unused */ $context = [])
    {
        return true;
    }

    /**
     * @param null $member

     * @param array $context
     *
     * @return bool|int
     */
    public function canEdit($member = null, $context = [])
    public function canEdit($member = null, /** @scrutinizer ignore-unused */ $context = [])
    {
        return Permission::check('Location_EDIT', 'any', $member);
    }

    /**
     * @param null $member

     * @param array $context
     *
     * @return bool|int
     */
    public function canDelete($member = null, $context = [])
    public function canDelete($member = null, /** @scrutinizer ignore-unused */ $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 array(
            'Location_EDIT' => 'Edit a Location',
            'Location_DELETE' => 'Delete a Location',
            'Location_CREATE' => 'Create a Location',
        );
    }
}

dynamic / silverstripe-locator

Pull Request — master (#173)

Location::canView() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
