CustomButton::getDropUp() - Code Metrics - Inspection of "Merge pull request #7 from gurucomkz/enable-dropup" - lekoala/silverstripe-cms-actions - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 227500...2b3681 )

by Thomas

created 2021-10-29 08:03 UTC

CustomButton::getDropUp() A

↳ Parent: CustomButton

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\CmsActions;

/**
 * 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 boolean
     */
    protected $dropUp = false;

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

    /**
     * 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
     *
     * @return $this
     */
    public function setTitle($title)
    {
        $this->title = $title;

        return $this;
    }

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

    }

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

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

        $btn = "btn-$type";
        $this->extraClasses[$btn] = $btn;

    }

    /**
     * Get the title with icon if set
     *
     * @return string
     */
    protected function getButtonTitle()
    {
        $title = $this->title;
        return $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 the value of confirmation
     */
    public function getConfirmation()
    {
        return $this->confirmation;
    }

    /**
     * Set the value of confirmation
     *
     * @param string|bool 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;
        return $this;
    }
}


1			<?php
2
3			namespace LeKoala\CmsActions;
4
5			/**
6			* Common button functionnality that is shared between CustomAction and CustomLink
7			*/
8			trait CustomButton
9			{
10			/**
11			* Default classes applied in constructor
12			* @config
13			* @var array
14			*/
15			private static $default_classes = [
16			'btn', 'btn-info'
17			];
18
19			/**
20			* Whether to place the button in a dot-menu
21			* @var boolean
22			*/
23			protected $dropUp = false;
24
25			/**
26			* An icon for this button
27			* @var string
28			*/
29			protected $buttonIcon;
30
31			/**
32			* The confirmation message
33			* @var string
34			*/
35			protected $confirmation;
36
37			/**
38			* Get the title of the link
39			* Called by ActionsGridFieldItemRequest to build default message
40			*
41			* @return string
42			*/
43			public function getTitle()
44			{
45			return $this->title;
46			}
47
48			/**
49			* Set the value of title
50			*
51			* @return $this
52			*/
53			public function setTitle($title)
54			{
55			$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...
56			return $this;
57			}
58
59			/**
60			* Get the dropUp malue
61			* Called by ActionsGridFieldItemRequest to determine placement
62			*
63			* @return string
64			*/
65			public function getDropUp()
66			{
67			return $this->dropUp;
			0 ignored issues – show Bug Best Practice introduced 2021-10-28 22:56 UTC by Report Bug Copy Issue Report The expression `return $this->dropUp` returns the type `boolean` which is incompatible with the documented return type `string`. Loading history...
68			}
69
70			/**
71			* Set the value of dropUp
72			*
73			* @return $this
74			*/
75			public function setDropUp($is)
76			{
77			$this->dropUp = !!$is;
78			return $this;
79			}
80
81			/**
82			* @param string $type
83			*
84			* @return void
85			*/
86			public function setButtonType($type)
87			{
88			if ($this->extraClasses) {
89			foreach ($this->extraClasses as $k => $v) {
90			if (strpos($k, 'btn-') !== false) {
91			unset($this->extraClasses[$k]);
92			}
93			}
94			}
95
96			$btn = "btn-$type";
97			$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...
98			}
99
100			/**
101			* Get the title with icon if set
102			*
103			* @return string
104			*/
105			protected function getButtonTitle()
106			{
107			$title = $this->title;
108			return $title;
109			}
110
111			/**
112			* Get an icon for this button
113			*
114			* @return string
115			*/
116			public function getButtonIcon()
117			{
118			return $this->buttonIcon;
119			}
120
121			/**
122			* Set an icon for this button
123			*
124			* Feel free to use SilverStripeIcons constants
125			*
126			* @param string $buttonIcon An icon for this button
127			* @return $this
128			*/
129			public function setButtonIcon(string $buttonIcon)
130			{
131			$this->buttonIcon = $buttonIcon;
132			return $this;
133			}
134
135			/**
136			* Get the value of confirmation
137			*/
138			public function getConfirmation()
139			{
140			return $this->confirmation;
141			}
142
143			/**
144			* Set the value of confirmation
145			*
146			* @param string\|bool A confirm message or true for a generic message
147			* @return $this
148			*/
149			public function setConfirmation($confirmation)
150			{
151			if ($confirmation === true) {
152			$confirmation = _t('CustomButton.CONFIRM_MESSAGE', 'Are you sure?');
153			}
154			$this->confirmation = $confirmation;
155			return $this;
156			}
157			}
158

lekoala / silverstripe-cms-actions

Push — master ( 227500...2b3681 )

CustomButton::getDropUp() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like