ElementCountDown::getSummary() - Code Metrics - Inspection of "implement `provideBlockSchema` (#17)" - dynamic/silverstripe-elemental-countdown - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 563851...e4f57d )

by Jason

created 2019-01-18 18:29 UTC

ElementCountDown::getSummary() A

↳ Parent: ElementCountDown

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace Dynamic\Elements\CountDown\Elements;

use DNADesign\Elemental\Models\BaseElement;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\View\ArrayData;

/**
 * Class ElementCountDown
 * @package Dynamic\Elements\Elements
 *
 * @property string $End
 * @property boolean $ShowMonths
 * @property boolean $ShowSeconds
 * @property boolean $Elapse
 */
class ElementCountDown extends BaseElement
{
    /**
     * @var string
     */
    private static $icon = 'font-icon-block-content';


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


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


    /**
     * @var string
     */
    private static $description = 'Displays a countdown to a specific date and time.';


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

        'End' => 'DBDatetime',
        'ShowMonths' => 'Boolean',
        'ShowSeconds' => 'Boolean',
        'Elapse' => 'Boolean',
    ];

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


    /**
     * @var ArrayData
     */
    private $client_config;

    /**
     * Sets the Date field to the current date.
     */
    public function populateDefaults()
    {
        $this->End = date('Y-m-d', strtotime("+30 days"));
        parent::populateDefaults();
    }

    /**
     * @return string
     */
    public function getSummary()
    {
        $end = $this->dbObject('End');
        return DBField::create_field(
            'HTMLText',
            'Count down to ' . $end->Date() . ' ' . $end->Time()
        )->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', 'Countdown');
    }

    /**
     * @return $this
     */
    public function setClientConfig()
    {
        $clientArray = [
            'End' => $this->End,
            'Elapse' => $this->Elapse,
        ];

        $this->client_config = ArrayData::create($this->encodeArrayValues($clientArray));

        return $this;
    }

    /**
     * @return ArrayData
     */
    public function getClientConfig()
    {
        if (!$this->client_config) {
            $this->setClientConfig();
        }

        return $this->client_config;
    }

    /**
     * @param $array
     * @return mixed
     */
    protected function encodeArrayValues($array)
    {
        foreach ($array as $key => $val) {
            $array[$key] = json_encode($val);
        }

        return $array;
    }
}


1		<?php
2
3		namespace Dynamic\Elements\CountDown\Elements;
4
5		use DNADesign\Elemental\Models\BaseElement;
6		use SilverStripe\ORM\FieldType\DBField;
7		use SilverStripe\View\ArrayData;
8
9		/**
10		* Class ElementCountDown
11		* @package Dynamic\Elements\Elements
12		*
13		* @property string $End
14		* @property boolean $ShowMonths
15		* @property boolean $ShowSeconds
16		* @property boolean $Elapse
17		*/
18		class ElementCountDown extends BaseElement
19		{
20		/**
21		* @var string
22		*/
23		private static $icon = 'font-icon-block-content';
		0 ignored issues – show introduced 2019-01-18 18:19 UTC by Report Bug Copy Issue Report The private property `$icon` is not used, and could be removed. Loading history...
24
25		/**
26		* @var string
27		*/
28		private static $singular_name = 'Countdown Element';
		0 ignored issues – show introduced 2018-04-24 19:02 UTC by Report Bug Copy Issue Report The private property `$singular_name` is not used, and could be removed. Loading history...
29
30		/**
31		* @var string
32		*/
33		private static $plural_name = 'Countdown Elements';
		0 ignored issues – show introduced 2018-04-24 19:02 UTC by Report Bug Copy Issue Report The private property `$plural_name` is not used, and could be removed. Loading history...
34
35		/**
36		* @var string
37		*/
38		private static $description = 'Displays a countdown to a specific date and time.';
		0 ignored issues – show introduced 2019-01-18 18:19 UTC by Report Bug Copy Issue Report The private property `$description` is not used, and could be removed. Loading history...
39
40		/**
41		* @var array
42		*/
43		private static $db = [
		0 ignored issues – show introduced 2018-04-24 19:02 UTC by Report Bug Copy Issue Report The private property `$db` is not used, and could be removed. Loading history...
44		'End' => 'DBDatetime',
45		'ShowMonths' => 'Boolean',
46		'ShowSeconds' => 'Boolean',
47		'Elapse' => 'Boolean',
48		];
49
50		/**
51		* @var string
52		*/
53		private static $table_name = 'ElementCountDown';
		0 ignored issues – show introduced 2018-04-24 19:02 UTC by Report Bug Copy Issue Report The private property `$table_name` is not used, and could be removed. Loading history...
54
55		/**
56		* @var ArrayData
57		*/
58		private $client_config;
59
60		/**
61		* Sets the Date field to the current date.
62		*/
63	1	public function populateDefaults()
64		{
65	1	$this->End = date('Y-m-d', strtotime("+30 days"));
66	1	parent::populateDefaults();
67		}
68
69		/**
70		* @return string
71		*/
72		public function getSummary()
73		{
74		$end = $this->dbObject('End');
75		return DBField::create_field(
76		'HTMLText',
77		'Count down to ' . $end->Date() . ' ' . $end->Time()
78		)->Summary(20);
79		}
80
81		/**
82		* @return array
83		*/
84		protected function provideBlockSchema()
85		{
86		$blockSchema = parent::provideBlockSchema();
87		$blockSchema['content'] = $this->getSummary();
88		return $blockSchema;
89		}
90
91		/**
92		* @return string
93		*/
94	1	public function getType()
95		{
96	1	return _t(__CLASS__ . '.BlockType', 'Countdown');
97		}
98
99		/**
100		* @return $this
101		*/
102	2	public function setClientConfig()
103		{
104		$clientArray = [
105	2	'End' => $this->End,
106	2	'Elapse' => $this->Elapse,
107		];
108
109	2	$this->client_config = ArrayData::create($this->encodeArrayValues($clientArray));
110
111	2	return $this;
112		}
113
114		/**
115		* @return ArrayData
116		*/
117	2	public function getClientConfig()
118		{
119	2	if (!$this->client_config) {
120	2	$this->setClientConfig();
121		}
122
123	2	return $this->client_config;
124		}
125
126		/**
127		* @param $array
128		* @return mixed
129		*/
130	2	protected function encodeArrayValues($array)
131		{
132	2	foreach ($array as $key => $val) {
133	2	$array[$key] = json_encode($val);
134		}
135
136	2	return $array;
137		}
138		}
139

dynamic / silverstripe-elemental-countdown

Push — master ( 563851...e4f57d )

ElementCountDown::getSummary() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like