PureModalAction::getButtonIcon() - Code Metrics - Inspection of "Customisable button" - lekoala/silverstripe-pure-modal - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#2)

by Sergey

created 2021-11-13 09:48 UTC

PureModalAction::getButtonIcon() A

↳ Parent: PureModalAction

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

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

<?php

namespace LeKoala\PureModal;

use SilverStripe\Forms\FieldList;
use SilverStripe\View\Requirements;
use SilverStripe\Forms\LiteralField;

/**
 * Custom modal action
 * Requires cms-actions to work out of the box
 */
class PureModalAction extends LiteralField
{
    /**
     * @var FieldList
     */
    protected $fieldList;

    /**
     * A custom title for the dialog button
     * @var string
     */
    protected $dialogButtonTitle;

    /**
     * Should it show the dialog button
     * @var boolean
     */
    protected $showDialogButton = true;

    /**
     * An icon for this button
     * @var string
     */
    protected $buttonIcon;

    /**
     * @var boolean
     */
    protected $shouldRefresh = false;

    public function __construct($name, $title)
    {
        $name = 'doCustomAction[' . $name . ']';
        $this->title = $title;
        $this->name = $name;
    }

    public function FieldHolder($properties = array())
    {
        Requirements::javascript('lekoala/silverstripe-pure-modal: client/pure-modal.js');
        Requirements::css('lekoala/silverstripe-pure-modal: client/pure-modal.css');

        $modalContent = '';
        foreach ($this->fieldList as $field) {
            $modalContent .= $field->FieldHolder();
        }

        $attrs = '';
        $modalID = 'modal_' . $this->name;

        $content = '';
        $content .= '<label for="' . $modalID . '" class="btn btn-info"' . $attrs . '>';
        $content .= $this->getButtonTitle();
        $content .= '</label>';
        $content .= '<div class="pure-modal from-top">';
        // This is how we show the modal
        $content .= '<input id="' . $modalID . '" class="checkbox" type="checkbox">';
        $content .= '<div class="pure-modal-overlay">';
        // Close in overlay
        $content .= '<label for="' . $modalID . '" class="o-close"></label>';
        $content .= '<div class="pure-modal-wrap">';
        // Close icon
        $content .= '<label for="' . $modalID . '" class="close">&#10006;</label>';
        $content .= $modalContent;

        // Add actual button
        if($this->showDialogButton) {
            $content .= '<button type="submit" name="action_' . $this->name . '" class="btn action btn btn-info custom-action">
                <span class="btn__title">' . $this->getButtonTitle() . '</span>
            </button>';
        }

        $content .= '</div>';
        $content .= '</div>';
        $content .= '</div>';
        $this->content = $content;

        return parent::FieldHolder($properties);
    }

    /**
     * Get the title with icon if set
     *
     * @return string
     */
    protected function getButtonTitle()
    {
        $title = $this->title;
        if ($this->buttonIcon) {
            $title = '<span class="font-icon-' . $this->buttonIcon . '"></span> ' . $title;
        }
        return $title;
    }

    /**
     * Get the dialog button title with icon if set
     *
     * @return string
     */
    protected function getDialogButtonTitle()
    {
        $title = $this->buttonTitle ?: $this->title;
        if ($this->buttonIcon) {
            $title = '<span class="font-icon-' . $this->buttonIcon . '"></span> ' . $title;
        }
        return $title;
    }

    /**
     * Set dialog button customised button title
     *
     * @return self
     */
    public function setDialogButtonTitle($value)
    {
        $this->buttonTitle = $value;

        return $this;
    }


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

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

    /**
     * Get whether it must display the dialog button
     *
     * @return boolean
     */
    protected function getShowDialogButton()
    {
        return $this->showDialogButton;
    }

    /**
     * Set whether it must display the dialog button
     *
     * @return self
     */
    public function setShowDialogButton($value)
    {
        $this->showDialogButton = !!$value;
        return $this;
    }



    /**
     * Get the value of fieldList
     * @return FieldList
     */
    public function getFieldList()
    {
        return $this->fieldList;
    }

    /**
     * Set the value of fieldList
     *
     * @param FieldList $fieldList
     * @return $this
     */
    public function setFieldList(FieldList $fieldList)
    {
        $this->fieldList = $fieldList;
        return $this;
    }

    /**
     * Required for cms-actions
     * @return string
     */
    public function actionName()
    {
        return rtrim(str_replace('doCustomAction[', '', $this->name), ']');
    }

    /**
     * Get the value of shouldRefresh
     * @return mixed
     */
    public function getShouldRefresh()
    {
        return $this->shouldRefresh;
    }

    /**
     * Set the value of shouldRefresh
     *
     * @param mixed $shouldRefresh
     * @return $this
     */
    public function setShouldRefresh($shouldRefresh)
    {
        $this->shouldRefresh = $shouldRefresh;
        return $this;
    }
}


1			<?php
2
3			namespace LeKoala\PureModal;
4
5			use SilverStripe\Forms\FieldList;
6			use SilverStripe\View\Requirements;
7			use SilverStripe\Forms\LiteralField;
8
9			/**
10			* Custom modal action
11			* Requires cms-actions to work out of the box
12			*/
13			class PureModalAction extends LiteralField
14			{
15			/**
16			* @var FieldList
17			*/
18			protected $fieldList;
19
20			/**
21			* A custom title for the dialog button
22			* @var string
23			*/
24			protected $dialogButtonTitle;
25
26			/**
27			* Should it show the dialog button
28			* @var boolean
29			*/
30			protected $showDialogButton = true;
31
32			/**
33			* An icon for this button
34			* @var string
35			*/
36			protected $buttonIcon;
37
38			/**
39			* @var boolean
40			*/
41			protected $shouldRefresh = false;
42
43			public function __construct($name, $title)
44			{
45			$name = 'doCustomAction[' . $name . ']';
46			$this->title = $title;
47			$this->name = $name;
48			}
49
50			public function FieldHolder($properties = array())
51			{
52			Requirements::javascript('lekoala/silverstripe-pure-modal: client/pure-modal.js');
53			Requirements::css('lekoala/silverstripe-pure-modal: client/pure-modal.css');
54
55			$modalContent = '';
56			foreach ($this->fieldList as $field) {
57			$modalContent .= $field->FieldHolder();
58			}
59
60			$attrs = '';
61			$modalID = 'modal_' . $this->name;
62
63			$content = '';
64			$content .= '<label for="' . $modalID . '" class="btn btn-info"' . $attrs . '>';
65			$content .= $this->getButtonTitle();
66			$content .= '</label>';
67			$content .= '<div class="pure-modal from-top">';
68			// This is how we show the modal
69			$content .= '<input id="' . $modalID . '" class="checkbox" type="checkbox">';
70			$content .= '<div class="pure-modal-overlay">';
71			// Close in overlay
72			$content .= '<label for="' . $modalID . '" class="o-close"></label>';
73			$content .= '<div class="pure-modal-wrap">';
74			// Close icon
75			$content .= '<label for="' . $modalID . '" class="close">✖</label>';
76			$content .= $modalContent;
77
78			// Add actual button
79			if($this->showDialogButton) {
80			$content .= '<button type="submit" name="action_' . $this->name . '" class="btn action btn btn-info custom-action">
81			<span class="btn__title">' . $this->getButtonTitle() . '</span>
82			</button>';
83			}
84
85			$content .= '</div>';
86			$content .= '</div>';
87			$content .= '</div>';
88			$this->content = $content;
89
90			return parent::FieldHolder($properties);
91			}
92
93			/**
94			* Get the title with icon if set
95			*
96			* @return string
97			*/
98			protected function getButtonTitle()
99			{
100			$title = $this->title;
101			if ($this->buttonIcon) {
102			$title = '<span class="font-icon-' . $this->buttonIcon . '"></span> ' . $title;
103			}
104			return $title;
105			}
106
107			/**
108			* Get the dialog button title with icon if set
109			*
110			* @return string
111			*/
112			protected function getDialogButtonTitle()
113			{
114			$title = $this->buttonTitle ?: $this->title;
115			if ($this->buttonIcon) {
116			$title = '<span class="font-icon-' . $this->buttonIcon . '"></span> ' . $title;
117			}
118			return $title;
119			}
120
121			/**
122			* Set dialog button customised button title
123			*
124			* @return self
125			*/
126			public function setDialogButtonTitle($value)
127			{
128			$this->buttonTitle = $value;
			0 ignored issues – show Bug Best Practice introduced 2021-11-13 09:50 UTC by Report Bug Copy Issue Report The property `buttonTitle` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
129			return $this;
130			}
131
132
133			/**
134			* Get an icon for this button
135			*
136			* @return string
137			*/
138			public function getButtonIcon()
139			{
140			return $this->buttonIcon;
141			}
142
143			/**
144			* Set an icon for this button
145			*
146			* Feel free to use SilverStripeIcons constants
147			*
148			* @param string $buttonIcon An icon for this button
149			* @return $this
150			*/
151			public function setButtonIcon(string $buttonIcon)
152			{
153			$this->buttonIcon = $buttonIcon;
154			return $this;
155			}
156
157			/**
158			* Get whether it must display the dialog button
159			*
160			* @return boolean
161			*/
162			protected function getShowDialogButton()
163			{
164			return $this->showDialogButton;
165			}
166
167			/**
168			* Set whether it must display the dialog button
169			*
170			* @return self
171			*/
172			public function setShowDialogButton($value)
173			{
174			$this->showDialogButton = !!$value;
175			return $this;
176			}
177
178
179
180			/**
181			* Get the value of fieldList
182			* @return FieldList
183			*/
184			public function getFieldList()
185			{
186			return $this->fieldList;
187			}
188
189			/**
190			* Set the value of fieldList
191			*
192			* @param FieldList $fieldList
193			* @return $this
194			*/
195			public function setFieldList(FieldList $fieldList)
196			{
197			$this->fieldList = $fieldList;
198			return $this;
199			}
200
201			/**
202			* Required for cms-actions
203			* @return string
204			*/
205			public function actionName()
206			{
207			return rtrim(str_replace('doCustomAction[', '', $this->name), ']');
208			}
209
210			/**
211			* Get the value of shouldRefresh
212			* @return mixed
213			*/
214			public function getShouldRefresh()
215			{
216			return $this->shouldRefresh;
217			}
218
219			/**
220			* Set the value of shouldRefresh
221			*
222			* @param mixed $shouldRefresh
223			* @return $this
224			*/
225			public function setShouldRefresh($shouldRefresh)
226			{
227			$this->shouldRefresh = $shouldRefresh;
228			return $this;
229			}
230			}
231

lekoala / silverstripe-pure-modal

Pull Request — master (#2)

PureModalAction::getButtonIcon() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like