PureModal::Type() - Code Metrics - Inspection of "make button type configurable" - lekoala/silverstripe-pure-modal - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 4b284b...6997c5 )

by Thomas

created 2024-11-14 14:47 UTC

PureModal::Type() A

↳ Parent: PureModal

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace LeKoala\PureModal;

use SilverStripe\View\SSViewer;
use SilverStripe\Forms\FormField;
use SilverStripe\Admin\ModelAdmin;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\Control\Controller;
use SilverStripe\Forms\DatalessField;
use SilverStripe\ORM\FieldType\DBHTMLText;

/**
 * A simple pure css modal for usage in the cms
 *
 * If your content contains a form, it should be loaded through an iframe
 * because you cannot nest forms (warning, this gets tricky with "move_modal_to_body")
 *
 * @author lekoala
 */
class PureModal extends DatalessField
{
    /**
     * @var string
     */
    protected $title;

    /**
     * @var string
     */
    protected $content;

    /**
     * @var string
     */
    protected $iframe;

    /**
     * @var bool
     */
    protected $iframeTop;

    /**
     * @var string|null
     */
    protected $buttonIcon = null;

    /**
     * @param string $name
     * @param string $title
     * @param string $content
     */
    public function __construct($name, $title, $content)
    {
        $this->setContent($content);

        // If you want, you can remove this and switch to another type
        $this->addExtraClass('btn-primary');

        parent::__construct($name, $title);
    }

    public function Type()
    {
        return 'pure-modal';
    }

    /**
     * @return string
     */
    public static function getMoveModalScript()
    {
        if (!self::config()->move_modal_to_body) {
            return '';
        }
        return "document.body.appendChild(this.parentElement.querySelector('.pure-modal'));this.onclick=null;";
    }

    /**
     * @return bool
     */
    public static function getOverlayTriggersCloseConfig()
    {
        return boolval(self::config()->overlay_triggers_close);
    }

    /**
     * For template usage
     * @return bool
     */
    public function getOverlayTriggersClose()
    {
        return PureModal::getOverlayTriggersCloseConfig();
    }

    /**
     * @return array<string,mixed>
     */
    public function getAttributes()
    {
        $attrs = [];
        // Move modal to body to avoid nesting issues
        $attrs['onclick'] = self::getMoveModalScript();
        // Since the frame is hidden, we need to compute size on click
        // TODO: fix this as it may report incorrect height
        if ($this->getIframe() && self::config()->compute_iframe_height) {
            $attrs['onclick'] .= "var i=document.querySelector('#" . $this->getIframeID() . "');i.style.height = 0; setTimeout(function() {i.style.height = i.contentWindow.document.body.scrollHeight + 'px';},100);";
        }
        return $attrs;
    }

    /**
     * Render a dialog
     *
     * @param Controller $controller
     * @param array<string,mixed> $customFields
     * @return string|DBHTMLText
     */
    public static function renderDialog($controller, $customFields = null)
    {
        // Set empty content by default otherwise it will render the full page
        if (empty($customFields['Content'])) {
            $customFields['Content'] = '';
        }

        $templates = SSViewer::get_templates_by_class(static::class, '_Dialog', __CLASS__);
        $templatesWithSuffix = SSViewer::chooseTemplate($templates);

        return $controller->renderWith($templatesWithSuffix, $customFields);
    }

    /**
     * Sets the content of this field to a new value.
     *
     * @param string|FormField $content
     * @return $this
     */
    public function setContent($content)
    {
        $this->content = $content;
        return $this;
    }

    /**
     * @return string
     */
    public function getContent()
    {
        return $this->content;
    }

    /**
     * Build an url for the current controller and pass along some parameters
     *
     * If you want to call actions on a model, use getModelLink
     *
     * @param string $action
     * @param array<string,mixed> $params
     * @return string
     */
    public function getControllerLink($action, array $params = null)
    {
        if ($params === null) {
            $params = [];
        }
        $ctrl = Controller::curr();
        if ($ctrl instanceof ModelAdmin) {
            $allParams = $ctrl->getRequest()->allParams();
            $modelClass = $ctrl->getRequest()->param('ModelClass');
            $action = $modelClass . '/' . $action;
            $params = array_merge($allParams, $params);
        }
        if (!empty($params)) {
            $action .= '?' . http_build_query($params);
        }
        return $ctrl->Link($action);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }

    /**
     * @param array<string,mixed> $properties
     * @return DBHTMLText
     */
    public function Field($properties = [])
    {
        $icon = $this->buttonIcon;
        if ($icon) {
            $this->addExtraClass('font-icon');
            $this->addExtraClass('font-icon-' . $icon);
        }
        return parent::Field($properties);
    }

    /**
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * @param string $title
     * @return $this
     */
    public function setTitle($title)
    {
        $this->title = $title;
        return $this;
    }

    /**
     * @return string
     */
    public function getIframe()
    {
        return $this->iframe;
    }

    /**
     * Link to iframe src
     *
     * @param string $iframe
     * @return $this
     */
    public function setIframe($iframe)
    {
        $this->iframe = $iframe;
        return $this;
    }

    /**
     * Helper for setIframe link using conventions
     *
     * @param string $action
     * @return $this
     */
    public function setIframeAction($action)
    {
        return $this->setIframe($this->getControllerLink($action));
    }

    /**
     * @return bool
     */
    public function getIframeTop()
    {
        return $this->iframeTop;
    }

    /**
     * Should the iframe be above the content
     *
     * @param bool $iframeTop
     * @return $this
     */
    public function setIframeTop($iframeTop)
    {
        $this->iframeTop = $iframeTop;
        return $this;
    }

    /**
     * @return string
     */
    public function getModalID()
    {
        return 'modal_' . $this->name;
    }

    /**
     * @return string
     */
    public function getIframeID()
    {
        return $this->getModalID() . '_iframe';
    }

    /**
     * Get an icon for this button
     *
     * @return string|null
     */
    public function getButtonIcon()
    {
        return $this->buttonIcon;
    }

    /**
     * Set an icon for this button
     *
     * Feel free to use SilverStripeIcons constants
     *
     * @param string|null $buttonIcon An icon for this button
     * @return $this
     */
    public function setButtonIcon(string $buttonIcon = null)
    {
        $this->buttonIcon = $buttonIcon;
        return $this;
    }
}


1			<?php
2
3			namespace LeKoala\PureModal;
4
5			use SilverStripe\View\SSViewer;
6			use SilverStripe\Forms\FormField;
7			use SilverStripe\Admin\ModelAdmin;
			0 ignored issues – show Bug introduced 2024-02-09 12:49 UTC by Report Bug Copy Issue Report The type `SilverStripe\Admin\ModelAdmin` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
8			use SilverStripe\Control\Controller;
9			use SilverStripe\Forms\DatalessField;
10			use SilverStripe\ORM\FieldType\DBHTMLText;
11
12			/**
13			* A simple pure css modal for usage in the cms
14			*
15			* If your content contains a form, it should be loaded through an iframe
16			* because you cannot nest forms (warning, this gets tricky with "move_modal_to_body")
17			*
18			* @author lekoala
19			*/
20			class PureModal extends DatalessField
21			{
22			/**
23			* @var string
24			*/
25			protected $title;
26
27			/**
28			* @var string
29			*/
30			protected $content;
31
32			/**
33			* @var string
34			*/
35			protected $iframe;
36
37			/**
38			* @var bool
39			*/
40			protected $iframeTop;
41
42			/**
43			* @var string\|null
44			*/
45			protected $buttonIcon = null;
46
47			/**
48			* @param string $name
49			* @param string $title
50			* @param string $content
51			*/
52			public function __construct($name, $title, $content)
53			{
54			$this->setContent($content);
55
56			// If you want, you can remove this and switch to another type
57			$this->addExtraClass('btn-primary');
58
59			parent::__construct($name, $title);
60			}
61
62			public function Type()
63			{
64			return 'pure-modal';
65			}
66
67			/**
68			* @return string
69			*/
70			public static function getMoveModalScript()
71			{
72			if (!self::config()->move_modal_to_body) {
73			return '';
74			}
75			return "document.body.appendChild(this.parentElement.querySelector('.pure-modal'));this.onclick=null;";
76			}
77
78			/**
79			* @return bool
80			*/
81			public static function getOverlayTriggersCloseConfig()
82			{
83			return boolval(self::config()->overlay_triggers_close);
84			}
85
86			/**
87			* For template usage
88			* @return bool
89			*/
90			public function getOverlayTriggersClose()
91			{
92			return PureModal::getOverlayTriggersCloseConfig();
93			}
94
95			/**
96			* @return array<string,mixed>
97			*/
98			public function getAttributes()
99			{
100			$attrs = [];
101			// Move modal to body to avoid nesting issues
102			$attrs['onclick'] = self::getMoveModalScript();
103			// Since the frame is hidden, we need to compute size on click
104			// TODO: fix this as it may report incorrect height
105			if ($this->getIframe() && self::config()->compute_iframe_height) {
106			$attrs['onclick'] .= "var i=document.querySelector('#" . $this->getIframeID() . "');i.style.height = 0; setTimeout(function() {i.style.height = i.contentWindow.document.body.scrollHeight + 'px';},100);";
107			}
108			return $attrs;
109			}
110
111			/**
112			* Render a dialog
113			*
114			* @param Controller $controller
115			* @param array<string,mixed> $customFields
116			* @return string\|DBHTMLText
117			*/
118			public static function renderDialog($controller, $customFields = null)
119			{
120			// Set empty content by default otherwise it will render the full page
121			if (empty($customFields['Content'])) {
122			$customFields['Content'] = '';
123			}
124
125			$templates = SSViewer::get_templates_by_class(static::class, '_Dialog', __CLASS__);
126			$templatesWithSuffix = SSViewer::chooseTemplate($templates);
127
128			return $controller->renderWith($templatesWithSuffix, $customFields);
129			}
130
131			/**
132			* Sets the content of this field to a new value.
133			*
134			* @param string\|FormField $content
135			* @return $this
136			*/
137			public function setContent($content)
138			{
139			$this->content = $content;
140			return $this;
141			}
142
143			/**
144			* @return string
145			*/
146			public function getContent()
147			{
148			return $this->content;
149			}
150
151			/**
152			* Build an url for the current controller and pass along some parameters
153			*
154			* If you want to call actions on a model, use getModelLink
155			*
156			* @param string $action
157			* @param array<string,mixed> $params
158			* @return string
159			*/
160			public function getControllerLink($action, array $params = null)
161			{
162			if ($params === null) {
163			$params = [];
164			}
165			$ctrl = Controller::curr();
166			if ($ctrl instanceof ModelAdmin) {
167			$allParams = $ctrl->getRequest()->allParams();
168			$modelClass = $ctrl->getRequest()->param('ModelClass');
169			$action = $modelClass . '/' . $action;
170			$params = array_merge($allParams, $params);
171			}
172			if (!empty($params)) {
173			$action .= '?' . http_build_query($params);
174			}
175			return $ctrl->Link($action);
			0 ignored issues – show Bug introduced 2024-02-09 12:49 UTC by Report Bug Copy Issue Report Are you sure the usage of `$ctrl->Link($action)` targeting `SilverStripe\Control\RequestHandler::Link()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
176			}
177
178			/**
179			* @param array<string,mixed> $properties
180			* @return DBHTMLText
181			*/
182			public function Field($properties = [])
183			{
184			$icon = $this->buttonIcon;
185			if ($icon) {
186			$this->addExtraClass('font-icon');
187			$this->addExtraClass('font-icon-' . $icon);
188			}
189			return parent::Field($properties);
190			}
191
192			/**
193			* @return string
194			*/
195			public function getTitle()
196			{
197			return $this->title;
198			}
199
200			/**
201			* @param string $title
202			* @return $this
203			*/
204			public function setTitle($title)
205			{
206			$this->title = $title;
207			return $this;
208			}
209
210			/**
211			* @return string
212			*/
213			public function getIframe()
214			{
215			return $this->iframe;
216			}
217
218			/**
219			* Link to iframe src
220			*
221			* @param string $iframe
222			* @return $this
223			*/
224			public function setIframe($iframe)
225			{
226			$this->iframe = $iframe;
227			return $this;
228			}
229
230			/**
231			* Helper for setIframe link using conventions
232			*
233			* @param string $action
234			* @return $this
235			*/
236			public function setIframeAction($action)
237			{
238			return $this->setIframe($this->getControllerLink($action));
239			}
240
241			/**
242			* @return bool
243			*/
244			public function getIframeTop()
245			{
246			return $this->iframeTop;
247			}
248
249			/**
250			* Should the iframe be above the content
251			*
252			* @param bool $iframeTop
253			* @return $this
254			*/
255			public function setIframeTop($iframeTop)
256			{
257			$this->iframeTop = $iframeTop;
258			return $this;
259			}
260
261			/**
262			* @return string
263			*/
264			public function getModalID()
265			{
266			return 'modal_' . $this->name;
267			}
268
269			/**
270			* @return string
271			*/
272			public function getIframeID()
273			{
274			return $this->getModalID() . '_iframe';
275			}
276
277			/**
278			* Get an icon for this button
279			*
280			* @return string\|null
281			*/
282			public function getButtonIcon()
283			{
284			return $this->buttonIcon;
285			}
286
287			/**
288			* Set an icon for this button
289			*
290			* Feel free to use SilverStripeIcons constants
291			*
292			* @param string\|null $buttonIcon An icon for this button
293			* @return $this
294			*/
295			public function setButtonIcon(string $buttonIcon = null)
296			{
297			$this->buttonIcon = $buttonIcon;
298			return $this;
299			}
300			}
301

lekoala / silverstripe-pure-modal

Push — master ( 4b284b...6997c5 )

PureModal::Type() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like