ModelAdminSnippet::getHTMLFragments() - Code Metrics - i-lateral/silverstripe-modeladminplus - Measure and Improve Code Quality continuously with Scrutinizer

ModelAdminSnippet::getHTMLFragments() A
last analyzed 2021-06-08 23:10 UTC

↳ Parent: ModelAdminSnippet

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	6
rs	10

<?php

namespace ilateral\SilverStripe\ModelAdminPlus;

use SilverStripe\View\ViewableData;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridField_HTMLProvider;

/**
 * Object representing a snippet of generic data that can be loaded at the top of a
 * ModelAdminPlus interface
 */
abstract class ModelAdminSnippet extends ViewableData implements GridField_HTMLProvider
{
    const PRIMARY = "primary";

    const SECONDARY = "secondary";

    const SUCCESS = "success";

    const INFO = "info";

    const WARNING = "warning";

    const DANGER = "danger";

    const LIGHT = "light";

    const DARK = "dark";

    const WHITE = "white";

    /**
     * @var string placement indicator for this control
     */
    protected $targetFragment;

    /**
     * The current parent gridfield
     *
     * @var GridField
     */
    protected $gridfield;

    /**
     * The name/title of the current snippet.
     *
     * @var string
     */
    private static $title;

    /**
     * The order in which this snippet will be loaded
     *
     * @var int
     */
    private static $priority = 0;

    /**
     * Default background colour
     *
     * @var string
     */
    private static $background = self::INFO;

    /**
     * Default text colour
     *
     * @var string
     */
    private static $text = self::WHITE;

    /**
     * List of extra CSS classes applied to this snippet
     *
     * @var array
     */
    protected $extra_classes = [];

    private $casting = [

        "Order" => "Float"
    ];

    /**
     * @param string $targetFragment The HTML fragment to write the button into
     */
    public function __construct($targetFragment = "after")
    {
        $this->targetFragment = $targetFragment;
    }

    public function getHTMLFragments($gridField)
    {
        $this->gridfield = $gridField;

        return [
            $this->targetFragment => $this->getSnippet()
        ];
    }

    /**
     * Return an i18n friendly version of the title.
     *
     * @return string
     */
    public function getTitle()
    {
        return _t(__CLASS__ . "Title", $this->config()->title);
    }

    public function getOrder()
    {
        return $this->config()->priority;
    }

    /**
     * Render the current snippet
     *
     * @return string
     */
    public function getSnippet()
    {
        return $this->renderWith(__CLASS__);
    }

    /**
     * Return the background colour suitable for a template
     *
     * @return string
     */
    public function getBackgroundColour()
    {
        return $this->config()->background;
    }

    /**
     * Return the background colour suitable for a template
     *
     * @return string
     */
    public function getTextColour()
    {
        return $this->config()->text;
    }

    /**
     * The content of this snippet that will be rendered below
     * the title.
     *
     * @return string
     */
    abstract public function getContent();

    /**
     * Get extra CSS classes as a string
     *
     * @return string
     */
    public function getExtraClasses()
    {
        return implode(" ", $this->extra_classes);
    }

    /**
     * Add additional css classes
     *
     * @param  array|string  $extra_classes  extra CSS classes
     *
     * @return  self
     */
    public function addExtraClasses($classes)
    {
        if (!is_array($classes)) {
            $classes = explode(" ", $classes);
        }

        $this->extra_classes = array_merge(
            $this->extra_classes,
            $classes
        );

        return $this;
    }

    /**
     * Remove provided CSS classes
     *
     * @param  array|string  $extra_classes  extra CSS classes
     *
     * @return  self
     */
    public function removeExtraClasses($classes)
    {
        if (!is_array($classes)) {
            $classes = explode(" ", $classes);
        }

        foreach ($classes as $class) {
            if (isset($this->extra_classes[$class])) {
                unset($this->extra_classes[$class]);
            }
        }

        return $this;
    }

    /**
     * Get the current parent gridfield
     *
     * @return  GridField
     */ 
    public function getGridfield()
    {
        return $this->gridfield;
    }
}


1			<?php
2
3			namespace ilateral\SilverStripe\ModelAdminPlus;
4
5			use SilverStripe\View\ViewableData;
6			use SilverStripe\Forms\GridField\GridField;
7			use SilverStripe\Forms\GridField\GridField_HTMLProvider;
8
9			/**
10			* Object representing a snippet of generic data that can be loaded at the top of a
11			* ModelAdminPlus interface
12			*/
13			abstract class ModelAdminSnippet extends ViewableData implements GridField_HTMLProvider
14			{
15			const PRIMARY = "primary";
16
17			const SECONDARY = "secondary";
18
19			const SUCCESS = "success";
20
21			const INFO = "info";
22
23			const WARNING = "warning";
24
25			const DANGER = "danger";
26
27			const LIGHT = "light";
28
29			const DARK = "dark";
30
31			const WHITE = "white";
32
33			/**
34			* @var string placement indicator for this control
35			*/
36			protected $targetFragment;
37
38			/**
39			* The current parent gridfield
40			*
41			* @var GridField
42			*/
43			protected $gridfield;
44
45			/**
46			* The name/title of the current snippet.
47			*
48			* @var string
49			*/
50			private static $title;
51
52			/**
53			* The order in which this snippet will be loaded
54			*
55			* @var int
56			*/
57			private static $priority = 0;
58
59			/**
60			* Default background colour
61			*
62			* @var string
63			*/
64			private static $background = self::INFO;
65
66			/**
67			* Default text colour
68			*
69			* @var string
70			*/
71			private static $text = self::WHITE;
72
73			/**
74			* List of extra CSS classes applied to this snippet
75			*
76			* @var array
77			*/
78			protected $extra_classes = [];
79
80			private $casting = [
			0 ignored issues – show introduced 2018-10-23 19:00 UTC by Report Bug Copy Issue Report The private property `$casting` is not used, and could be removed. Loading history...
81			"Order" => "Float"
82			];
83
84			/**
85			* @param string $targetFragment The HTML fragment to write the button into
86			*/
87			public function __construct($targetFragment = "after")
88			{
89			$this->targetFragment = $targetFragment;
90			}
91
92			public function getHTMLFragments($gridField)
93			{
94			$this->gridfield = $gridField;
95
96			return [
97			$this->targetFragment => $this->getSnippet()
98			];
99			}
100
101			/**
102			* Return an i18n friendly version of the title.
103			*
104			* @return string
105			*/
106			public function getTitle()
107			{
108			return _t(__CLASS__ . "Title", $this->config()->title);
109			}
110
111			public function getOrder()
112			{
113			return $this->config()->priority;
114			}
115
116			/**
117			* Render the current snippet
118			*
119			* @return string
120			*/
121			public function getSnippet()
122			{
123			return $this->renderWith(__CLASS__);
124			}
125
126			/**
127			* Return the background colour suitable for a template
128			*
129			* @return string
130			*/
131			public function getBackgroundColour()
132			{
133			return $this->config()->background;
134			}
135
136			/**
137			* Return the background colour suitable for a template
138			*
139			* @return string
140			*/
141			public function getTextColour()
142			{
143			return $this->config()->text;
144			}
145
146			/**
147			* The content of this snippet that will be rendered below
148			* the title.
149			*
150			* @return string
151			*/
152			abstract public function getContent();
153
154			/**
155			* Get extra CSS classes as a string
156			*
157			* @return string
158			*/
159			public function getExtraClasses()
160			{
161			return implode(" ", $this->extra_classes);
162			}
163
164			/**
165			* Add additional css classes
166			*
167			* @param array\|string $extra_classes extra CSS classes
168			*
169			* @return self
170			*/
171			public function addExtraClasses($classes)
172			{
173			if (!is_array($classes)) {
174			$classes = explode(" ", $classes);
175			}
176
177			$this->extra_classes = array_merge(
178			$this->extra_classes,
179			$classes
180			);
181
182			return $this;
183			}
184
185			/**
186			* Remove provided CSS classes
187			*
188			* @param array\|string $extra_classes extra CSS classes
189			*
190			* @return self
191			*/
192			public function removeExtraClasses($classes)
193			{
194			if (!is_array($classes)) {
195			$classes = explode(" ", $classes);
196			}
197
198			foreach ($classes as $class) {
199			if (isset($this->extra_classes[$class])) {
200			unset($this->extra_classes[$class]);
201			}
202			}
203
204			return $this;
205			}
206
207			/**
208			* Get the current parent gridfield
209			*
210			* @return GridField
211			*/
212			public function getGridfield()
213			{
214			return $this->gridfield;
215			}
216			}
217

i-lateral / silverstripe-modeladminplus

ModelAdminSnippet::getHTMLFragments() A last analyzed 2021-06-08 23:10 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ModelAdminSnippet::getHTMLFragments() A
last analyzed 2021-06-08 23:10 UTC