ElementAccordion::provideBlockSchema() - Code Metrics - Inspection of "add support for Elemental 4" - dynamic/silverstripe-elemental-accordion - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#18)

by Jason

created 2019-01-20 03:03 UTC

ElementAccordion::provideBlockSchema() A

↳ Parent: ElementAccordion

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	0
dl	0
loc	5
ccs	0
cts	0
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php

namespace Dynamic\Elements\Accordion\Elements;

use DNADesign\Elemental\Models\BaseElement;
use Dynamic\Elements\Accordion\Model\AccordionPanel;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
use SilverStripe\Forms\GridField\GridFieldDeleteAction;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\ORM\FieldType\DBHTMLText;
use Symbiote\GridFieldExtensions\GridFieldOrderableRows;

/**
 * Class ElementAccordion
 * @package Dynamic\Elements\Accordion\Elements
 *
 * @property string $Content
 *
 * @method \SilverStripe\ORM\HasManyList Panels()
 */
class ElementAccordion extends BaseElement
{
    /**
     * @var string
     */
    private static $icon = 'font-icon-block-content';


    /**
     * @var string
     */
    private static $singular_name = 'Accordion';


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


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


    /**
     * @var string
     */
    private static $description = 'A collapsing list of content';


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

        'Content' => 'HTMLText',
    ];

    /**
     * @var array
     */
    private static $has_many = array(

        'Panels' => AccordionPanel::class,
    );

    /**
     * Set to false to prevent an in-line edit form from showing in an elemental area. Instead the element will be
     * clickable and a GridFieldDetailForm will be used.
     *
     * @config
     * @var bool
     */
    private static $inline_editable = false;


    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $this->beforeUpdateCMSFields(function ($fields) {
            /* @var FieldList $fields */
            $fields->removeByName(array(
                'Sort',
            ));

            $fields->dataFieldByName('Content')
                ->setRows(8);

            if ($this->ID) {
                /** @var GridField $panels */
                $panels = $fields->dataFieldByName('Panels');
                $panels->setTitle(_t(__CLASS__.'.Panels', 'Panels'));

                $config = $panels->getConfig();
                $config->addComponent(new GridFieldOrderableRows('Sort'));
                $config->removeComponentsByType(GridFieldAddExistingAutocompleter::class);
                $config->removeComponentsByType(GridFieldDeleteAction::class);
            }
        });

        return parent::getCMSFields();
    }

    /**
     * @return DBHTMLText
     */
    public function getSummary()
    {
        if ($this->Panels()->count() == 1) {
            $label = ' panel';
        } else {
            $label = ' panels';
        }
        return DBField::create_field('HTMLText', $this->Panels()->count() . $label)->Summary(20);
    }

    /**
     * @return array
     */
    protected function provideBlockSchema()
    {
        $blockSchema = parent::provideBlockSchema();
        $blockSchema['content'] = $this->getSummary();
        return $blockSchema;
    }

    /**
     * @return string
     */
    public function getType()
    {
        return _t(__CLASS__.'.BlockType', 'Accordion');
    }
}


1		<?php
2
3		namespace Dynamic\Elements\Accordion\Elements;
4
5		use DNADesign\Elemental\Models\BaseElement;
6		use Dynamic\Elements\Accordion\Model\AccordionPanel;
7		use SilverStripe\Forms\FieldList;
8		use SilverStripe\Forms\GridField\GridField;
9		use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
10		use SilverStripe\Forms\GridField\GridFieldDeleteAction;
11		use SilverStripe\ORM\FieldType\DBField;
12		use SilverStripe\ORM\FieldType\DBHTMLText;
13		use Symbiote\GridFieldExtensions\GridFieldOrderableRows;
14
15		/**
16		* Class ElementAccordion
17		* @package Dynamic\Elements\Accordion\Elements
18		*
19		* @property string $Content
20		*
21		* @method \SilverStripe\ORM\HasManyList Panels()
22		*/
23		class ElementAccordion extends BaseElement
24		{
25		/**
26		* @var string
27		*/
28		private static $icon = 'font-icon-block-content';
		0 ignored issues – show introduced 2019-01-20 03:15 UTC by Report Bug Copy Issue Report The private property `$icon` is not used, and could be removed. Loading history...
29
30		/**
31		* @var string
32		*/
33		private static $singular_name = 'Accordion';
		0 ignored issues – show introduced 2018-04-24 15:31 UTC by Report Bug Copy Issue Report The private property `$singular_name` is not used, and could be removed. Loading history...
34
35		/**
36		* @var string
37		*/
38		private static $plural_name = 'Accordions';
		0 ignored issues – show introduced 2018-04-24 15:31 UTC by Report Bug Copy Issue Report The private property `$plural_name` is not used, and could be removed. Loading history...
39
40		/**
41		* @var string
42		*/
43		private static $table_name = 'ElementAccordion';
		0 ignored issues – show introduced 2018-04-24 15:31 UTC by Report Bug Copy Issue Report The private property `$table_name` is not used, and could be removed. Loading history...
44
45		/**
46		* @var string
47		*/
48		private static $description = 'A collapsing list of content';
		0 ignored issues – show introduced 2018-04-24 15:31 UTC by Report Bug Copy Issue Report The private property `$description` is not used, and could be removed. Loading history...
49
50		/**
51		* @var array
52		*/
53		private static $db = [
		0 ignored issues – show introduced 2018-04-24 15:31 UTC by Report Bug Copy Issue Report The private property `$db` is not used, and could be removed. Loading history...
54		'Content' => 'HTMLText',
55		];
56
57		/**
58		* @var array
59		*/
60		private static $has_many = array(
		0 ignored issues – show introduced 2018-04-24 15:31 UTC by Report Bug Copy Issue Report The private property `$has_many` is not used, and could be removed. Loading history...
61		'Panels' => AccordionPanel::class,
62		);
63
64		/**
65		* Set to false to prevent an in-line edit form from showing in an elemental area. Instead the element will be
66		* clickable and a GridFieldDetailForm will be used.
67		*
68		* @config
69	1	* @var bool
70		*/
71	1	private static $inline_editable = false;
		0 ignored issues – show introduced 2019-01-20 03:15 UTC by Report Bug Copy Issue Report The private property `$inline_editable` is not used, and could be removed. Loading history...
72	1
73		/**
74		* @return FieldList
75	1	*/
76	1	public function getCMSFields()
77		{
78	1	$this->beforeUpdateCMSFields(function ($fields) {
79		/* @var FieldList $fields */
80	1	$fields->removeByName(array(
81	1	'Sort',
82		));
83	1
84	1	$fields->dataFieldByName('Content')
85	1	->setRows(8);
86	1
87		if ($this->ID) {
88	1	/** @var GridField $panels */
89		$panels = $fields->dataFieldByName('Panels');
90	1	$panels->setTitle(_t(__CLASS__.'.Panels', 'Panels'));
91
92		$config = $panels->getConfig();
93		$config->addComponent(new GridFieldOrderableRows('Sort'));
94		$config->removeComponentsByType(GridFieldAddExistingAutocompleter::class);
95		$config->removeComponentsByType(GridFieldDeleteAction::class);
96	1	}
97		});
98	1
99		return parent::getCMSFields();
100		}
101
102		/**
103		* @return DBHTMLText
104	1	*/
105		public function getSummary()
106	1	{
107		if ($this->Panels()->count() == 1) {
108		$label = ' panel';
109		} else {
110		$label = ' panels';
111		}
112		return DBField::create_field('HTMLText', $this->Panels()->count() . $label)->Summary(20);
113		}
114
115		/**
116		* @return array
117		*/
118		protected function provideBlockSchema()
119		{
120		$blockSchema = parent::provideBlockSchema();
121		$blockSchema['content'] = $this->getSummary();
122		return $blockSchema;
123		}
124
125		/**
126		* @return string
127		*/
128		public function getType()
129		{
130		return _t(__CLASS__.'.BlockType', 'Accordion');
131		}
132		}
133

dynamic / silverstripe-elemental-accordion

Pull Request — master (#18)

ElementAccordion::provideBlockSchema() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like