Locator::getCMSFields() - 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
Locator::getCMSFields() B

↳ Parent: Locator
Complexity

Conditions	1
Paths	1
Size

Total Lines	33
Code Lines	21
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	21
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	33
rs	8.8571
<?php

namespace Dynamic\Locator;

use \Page;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\Control\Director;
use SilverStripe\Core\Manifest\ModuleLoader;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\HeaderField;
use SilverStripe\Forms\OptionsetField;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldConfig_RelationEditor;
use SilverStripe\ORM\DataList;
use SilverStripe\ORM\ArrayList;
use SilverStripe\Core\Config\Config;
use SilverStripe\View\ArrayData;
use Symbiote\GridFieldExtensions\GridFieldAddExistingSearchButton;

/**
 * Class Locator
 *
 * @property bool $AutoGeocode
 * @property bool $ModalWindow
 * @property string $Unit
 * @method Categories|ManyManyList $Categories
 */
class Locator extends Page
{
    /**
     * @var string
     */
    private static $singular_name = 'Locator';

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

    /**
     * @var string
     */
    private static $description = 'Display locations on a map';

    /**
     * @var bool
     */
    private static $show_radius = true;


    private static $limit = -1;


    private static $locationClass = Location::class;


    /**
     * @var array
     */
    private static $db = array(
        'Unit' => 'Enum("m,km","m")',
        'Clusters' => 'Enum("false,true","false")',
    );

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

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


    /**
     * @var string
     */
    private static $location_class = Location::class;


    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        // so it can easily be extended - concept taken from the blog module
        $this->beforeUpdateCMSFields(function ($fields) {
            // Settings
            $fields->addFieldsToTab('Root.Settings', array(
                HeaderField::create('DisplayOptions', 'Display Options', 3),
                HeaderField::create('DisplayOptions', 'Display Options', /** @scrutinizer ignore-type */ 3),
                OptionsetField::create('Unit', 'Unit of measure', array(
                    'm' => 'Miles',
                    'km' => 'Kilometers'
                ), 'm'),
                OptionsetField::create('Clusters', 'Use clusters?', array(
                    'false' => 'No',
                    'true' => 'Yes'
                ), 'false'),
            ));

            // Filter categories
            $config = GridFieldConfig_RelationEditor::create();
            $config->removeComponentsByType('GridFieldAddExistingAutocompleter');
            $config->addComponent(new GridFieldAddExistingSearchButton());
            $categories = $this->Categories();
            $categoriesField = GridField::create('Categories', 'Categories', $categories, $config)
                                        ->setDescription('only show locations from the selected category');

            // Filter
            $fields->addFieldsToTab('Root.Filter', array(
                HeaderField::create('CategoryOptionsHeader', 'Location Filtering', 3),
                $categoriesField,
            ));
        });

        return parent::getCMSFields();
    }

    /**
     * Gets the list of radius
     *
     * @return ArrayList
     */
    public function getRadii()
    {
        $radii = [
            '0' => '25',
            '1' => '50',
            '2' => '75',
            '3' => '100',
        ];

        $config_radii = Config::inst()->get(Locator::class, 'radius_array');
        if ($config_radii) {
            $radii = $config_radii;
        }

        $list = [];
        foreach ($radii as $radius) {
            $list[] = new ArrayData(array(
                'Radius' => $radius,
            ));
        }

        return new ArrayList($list);
    }

    /**
     * Gets the limit of locations
     * @return mixed
     */
    public function getLimit()
    {
        return Config::inst()->get(Locator::class, 'limit');
    }

    /**
     * Gets if the radius drop down should be shown
     * @return mixed
     */
    public function getShowRadius()
    {
        return Config::inst()->get(Locator::class, 'show_radius');
    }

    /**
     * @return mixed
     */
    public function getCategories()
    {
        return $this->Categories()->filter(array(
            'Locations.ID:GreaterThan' => 0
        ));
    }

    /**
     * Gets the info window template
     * @return mixed
     */
    public function getInfoWindowTemplate()

    {
        $contents = json_encode(
            file_get_contents(
                $this->parseModuleResourceReference(
                    Config::inst()->get(
                        Locator::class,
                        'infoWindowTemplate'
                    )
                )
            )
        );

        return str_replace('\n', '', $contents);
    }

    /**
     * Gets the template for locations in the list
     * @return string
     */
    public function getListTemplate()

    {
        $contents = json_encode(
            file_get_contents(
                $this->parseModuleResourceReference(
                    Config::inst()->get(
                        Locator::class,
                        'listTemplate'
                    )
                )
            )
        );

        return str_replace('\n', '', $contents);
    }

    /**
     * From SilverStripe/View/Requirements_Backend
     *
     * Modified to use the base folder
     */
    protected function parseModuleResourceReference($file)
    {
        // String of the form vendor/package:resource. Excludes "http://bla" as that's an absolute URL
        if (preg_match('#([^\/\/][^ /]*\/[^ /]*) *: *([^ ]*)#', $file, $matches)) {
            list(, $module, $resource) = $matches;
            $moduleObj = ModuleLoader::getModule($module);
            if (!$moduleObj) {
                throw new \InvalidArgumentException("Can't find module '$module'");
            }

            return Director::baseFolder() . '/' . $moduleObj->getRelativeResourcePath($resource);
            return Director::baseFolder() . '/' . /** @scrutinizer ignore-deprecated */ $moduleObj->getRelativeResourcePath($resource);
        }

        return $file;
    }

    /**
     * @param array $filter
     * @param array $filterAny
     * @param array $exclude
     * @param null|callable $callback
     *
     * @return DataList|ArrayList
     */
    public static function get_locations(
        $filter = [],
        $filterAny = [],
        $exclude = [],
        $callback = null
    ) {
        $locationClass = Config::inst()->get(Locator::class, 'location_class');
        $locations = $locationClass::get()->filter($filter)->exclude($exclude);
        if (!empty($filterAny)) {
            $locations = $locations->filterAny($filterAny);
        }

        if (!empty($exclude)) {
            $locations = $locations->exclude($exclude);
        }

        if ($callback !== null && is_callable($callback)) {
            $locations->filterByCallback($callback);
        }

        return $locations;
    }
}

dynamic / silverstripe-locator

Pull Request — master (#173)

Locator::getCMSFields() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
