CustomButton::renderLastIcon() - Code Metrics - lekoala/silverstripe-cms-actions - Measure and Improve Code Quality continuously with Scrutinizer

CustomButton::renderLastIcon() A
last analyzed 2025-06-19 20:19 UTC

↳ Parent: CustomButton

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace LeKoala\CmsActions;

use SilverStripe\View\HTML;

/**
 * Common button functionnality that is shared between CustomAction and CustomLink
 */
trait CustomButton
{
    /**
     * Default classes applied in constructor
     * @config
     * @var array
     */
    private static $default_classes = [
        'btn',
        'btn-info'
    ];

    /**
     * Whether to place the button in a dot-menu
     * @var bool
     */
    protected $dropUp = false;

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

    /**
     * An icon using l-i element
     * @var array
     */
    protected $lastIcon = [];

    /**
     * The confirmation message
     * @var string
     */
    protected $confirmation;

    /**
     * Get the title of the link
     * Called by ActionsGridFieldItemRequest to build default message
     *
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * Set the value of title
     *
     * @param string $title
     * @return $this
     */
    public function setTitle($title)
    {
        $this->title = $title;


        return $this;
    }

    /**
     * Get the dropUp value
     * Called by ActionsGridFieldItemRequest to determine placement
     *
     * @return bool
     */
    public function getDropUp()
    {
        return $this->dropUp;
    }

    /**
     * Set the value of dropUp
     *
     * @param bool $is
     * @return $this
     */
    public function setDropUp($is)
    {
        $this->dropUp = !!$is;

        return $this;
    }

    /**
     * @param string $type
     * @return $this
     */
    public function setButtonType($type)
    {
        if ($this->extraClasses) {
            foreach ($this->extraClasses as $k => $v) {
                if (strpos($k, 'btn-') !== false) {
                    unset($this->extraClasses[$k]);
                }
            }
        }

        $btn = sprintf('btn-%s', $type);
        $this->extraClasses[$btn] = $btn;


        return $this;
    }

    /**
     * Get the title with icon if set
     *
     * @return string
     */
    protected function getButtonTitle()
    {
        return $this->title;
    }

    /**
     * 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 an icon for this button
     *
     * @return array
     */
    public function getLastIcon()
    {
        return $this->lastIcon;
    }

    /**
     * Set an icon for this button
     *
     * @param string|array $lastIcon An icon for this button
     * @param string $set
     * @param string $type
     * @param string $size
     * @return $this
     */
    public function setLastIcon($lastIcon, $set = null, $type = null, $size = null)
    {
        if (is_string($lastIcon)) {
            $lastIcon = [
                'name' => $lastIcon
            ];
        }
        if ($set) {
            $lastIcon['set'] = $set;
        }
        if ($type) {
            $lastIcon['type'] = $type;
        }
        if ($size) {
            $lastIcon['size'] = $size;
        }
        $this->lastIcon = $lastIcon;

        return $this;
    }

    /**
     * @return boolean
     */
    public function hasLastIcon()
    {
        return !empty($this->lastIcon['name']);
    }

    /**
     * @return string
     */
    public function renderLastIcon()
    {
        if (!$this->hasLastIcon()) {
            return '';
        }
        return HTML::createTag('l-i', $this->lastIcon);
    }

    /**
     * Get the value of confirmation
     * @return bool|string
     */
    public function getConfirmation()
    {
        return $this->confirmation;
    }

    /**
     * Set the value of confirmation
     *
     * @param string|bool $confirmation A confirm message or true for a generic message
     * @return $this
     */
    public function setConfirmation($confirmation)
    {
        if ($confirmation === true) {
            $confirmation = _t('CustomButton.CONFIRM_MESSAGE', 'Are you sure?');
        }
        $this->confirmation = $confirmation;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        return $this;
    }
}


1			<?php
2
3			namespace LeKoala\CmsActions;
4
5			use SilverStripe\View\HTML;
6
7			/**
8			* Common button functionnality that is shared between CustomAction and CustomLink
9			*/
10			trait CustomButton
11			{
12			/**
13			* Default classes applied in constructor
14			* @config
15			* @var array
16			*/
17			private static $default_classes = [
18			'btn',
19			'btn-info'
20			];
21
22			/**
23			* Whether to place the button in a dot-menu
24			* @var bool
25			*/
26			protected $dropUp = false;
27
28			/**
29			* An icon for this button
30			* @var string\|null
31			*/
32			protected $buttonIcon;
33
34			/**
35			* An icon using l-i element
36			* @var array
37			*/
38			protected $lastIcon = [];
39
40			/**
41			* The confirmation message
42			* @var string
43			*/
44			protected $confirmation;
45
46			/**
47			* Get the title of the link
48			* Called by ActionsGridFieldItemRequest to build default message
49			*
50			* @return string
51			*/
52			public function getTitle()
53			{
54			return $this->title;
55			}
56
57			/**
58			* Set the value of title
59			*
60			* @param string $title
61			* @return $this
62			*/
63			public function setTitle($title)
64			{
65			$this->title = $title;
			0 ignored issues – show Bug Best Practice introduced 2020-12-14 08:32 UTC by Report Bug Copy Issue Report The property `title` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
66
67			return $this;
68			}
69
70			/**
71			* Get the dropUp value
72			* Called by ActionsGridFieldItemRequest to determine placement
73			*
74			* @return bool
75			*/
76			public function getDropUp()
77			{
78			return $this->dropUp;
79			}
80
81			/**
82			* Set the value of dropUp
83			*
84			* @param bool $is
85			* @return $this
86			*/
87			public function setDropUp($is)
88			{
89			$this->dropUp = !!$is;
90
91			return $this;
92			}
93
94			/**
95			* @param string $type
96			* @return $this
97			*/
98			public function setButtonType($type)
99			{
100			if ($this->extraClasses) {
101			foreach ($this->extraClasses as $k => $v) {
102			if (strpos($k, 'btn-') !== false) {
103			unset($this->extraClasses[$k]);
104			}
105			}
106			}
107
108			$btn = sprintf('btn-%s', $type);
109			$this->extraClasses[$btn] = $btn;
			0 ignored issues – show Bug Best Practice introduced 2020-12-14 08:32 UTC by Report Bug Copy Issue Report The property `extraClasses` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
110
111			return $this;
112			}
113
114			/**
115			* Get the title with icon if set
116			*
117			* @return string
118			*/
119			protected function getButtonTitle()
120			{
121			return $this->title;
122			}
123
124			/**
125			* Get an icon for this button
126			*
127			* @return string
128			*/
129			public function getButtonIcon()
130			{
131			return $this->buttonIcon;
132			}
133
134			/**
135			* Set an icon for this button
136			*
137			* Feel free to use SilverStripeIcons constants
138			*
139			* @param string $buttonIcon An icon for this button
140			* @return $this
141			*/
142			public function setButtonIcon(string $buttonIcon)
143			{
144			$this->buttonIcon = $buttonIcon;
145
146			return $this;
147			}
148
149			/**
150			* Get an icon for this button
151			*
152			* @return array
153			*/
154			public function getLastIcon()
155			{
156			return $this->lastIcon;
157			}
158
159			/**
160			* Set an icon for this button
161			*
162			* @param string\|array $lastIcon An icon for this button
163			* @param string $set
164			* @param string $type
165			* @param string $size
166			* @return $this
167			*/
168			public function setLastIcon($lastIcon, $set = null, $type = null, $size = null)
169			{
170			if (is_string($lastIcon)) {
171			$lastIcon = [
172			'name' => $lastIcon
173			];
174			}
175			if ($set) {
176			$lastIcon['set'] = $set;
177			}
178			if ($type) {
179			$lastIcon['type'] = $type;
180			}
181			if ($size) {
182			$lastIcon['size'] = $size;
183			}
184			$this->lastIcon = $lastIcon;
185
186			return $this;
187			}
188
189			/**
190			* @return boolean
191			*/
192			public function hasLastIcon()
193			{
194			return !empty($this->lastIcon['name']);
195			}
196
197			/**
198			* @return string
199			*/
200			public function renderLastIcon()
201			{
202			if (!$this->hasLastIcon()) {
203			return '';
204			}
205			return HTML::createTag('l-i', $this->lastIcon);
206			}
207
208			/**
209			* Get the value of confirmation
210			* @return bool\|string
211			*/
212			public function getConfirmation()
213			{
214			return $this->confirmation;
215			}
216
217			/**
218			* Set the value of confirmation
219			*
220			* @param string\|bool $confirmation A confirm message or true for a generic message
221			* @return $this
222			*/
223			public function setConfirmation($confirmation)
224			{
225			if ($confirmation === true) {
226			$confirmation = _t('CustomButton.CONFIRM_MESSAGE', 'Are you sure?');
227			}
228			$this->confirmation = $confirmation;
			0 ignored issues – show Documentation Bug introduced 2024-12-02 11:38 UTC by Report Bug Copy Issue Report It seems like `$confirmation` can also be of type `false`. However, the property `$confirmation` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
229
230			return $this;
231			}
232			}
233

lekoala / silverstripe-cms-actions

CustomButton::renderLastIcon() A last analyzed 2025-06-19 20:19 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

CustomButton::renderLastIcon() A
last analyzed 2025-06-19 20:19 UTC