SilverStripe\CKANRegistry\Model\ResourceField

Complexity

Total Complexity

3

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getCMSFields()	0	19	1
A	getReadableName()	0	3	2

<?php

namespace SilverStripe\CKANRegistry\Model;

use SilverStripe\Forms\CheckboxField;
use SilverStripe\Forms\FieldGroup;
use SilverStripe\i18n\i18n;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\FieldType\DBString;

/**
 * Represents a generic field on a CKAN Resource, e.g. a column in a spreadsheet.
 * It is intentionally generic, as the resource may not be a tabular one, e.g. geospatal data to be rendered in a map.
 */
class ResourceField extends DataObject
{
    private static $table_name = 'CKANResourceField';

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

    private static $db = [

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

        'Name' => 'Varchar',
        'Type' => 'Varchar',
        'ReadableName' => 'Varchar',
        'ShowInSummaryView' => 'Boolean',
        'ShowInDetailView' => 'Boolean',
        'RemoveDuplicates' => 'Boolean',
        'Order' => 'Int',
        'DisplayConditions' => 'Text',
    ];

    private static $has_one = [

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

        'Resource' => Resource::class,
    ];

    private static $summary_fields = [

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

        'Order',
        'ReadableName',
        'Name',
        'Type',
        'ShowInSummaryView',
        'ShowInDetailView',
    ];

    /**
     * Always display the 'ReadableName' unless it's unset, then display the name that is returned by CKAN
     * @return string|DBString
     */
    public function getReadableName()
    {
        return $this->getField('ReadableName') ?: $this->Name;

The property Name does not exist on SilverStripe\CKANRegistry\Model\ResourceField. Since you implemented __get, consider adding a @property annotation.

    }

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $fields->removeByName('Name');

        $fields->removeByName('Type');
        $fields->dataFieldByName('ReadableName')
            ->setAttribute('placeholder', $this->Name);

The property Name does not exist on SilverStripe\CKANRegistry\Model\ResourceField. Since you implemented __get, consider adding a @property annotation.

        $summary = $fields->dataFieldByName('ShowInSummaryView');
        $detail = $fields->dataFieldByName('ShowInDetailView');
        $duplicates = $fields->dataFieldByName('RemoveDuplicates');

        $fields->removeByName(['ShowInSummaryView', 'ShowInDetailView', 'RemoveDuplicates',]);
        $fields->insertBefore(FieldGroup::create('Visibility', [$summary, $detail, $duplicates]), 'Order');

'Order' of type string is incompatible with the type SilverStripe\Forms\FormField expected by parameter $item of SilverStripe\Forms\FieldList::insertBefore().

        $fields->removeByName('ResourceID');
        return $fields;
    }
}