Alert::asXML() - Code Metrics - symphonycms/symphony-2 - Measure and Improve Code Quality continuously with Scrutinizer

Alert::asXML() A
last analyzed 2019-04-08 19:56 UTC

↳ Parent: Alert

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * @package toolkit
 */
/**
 * The Alert class drives the standard Symphony notices that
 * appear at the top of the backend pages to alert the user of
 * something. Their are three default alert styles, notice, error
 * and success.
 */
class Alert
{
    /**
     * Represents a notice, usually used for non blocking alerts,
     * just to inform that user that something has happened and
     * they need to aware of it
     * @var string
     */
    const NOTICE = 'notice';

    /**
     * Represents an error, used when something has gone wrong during
     * the previous action. It is blocking, in that the action has
     * not completed successfully.
     * @var string
     */
    const ERROR = 'error';

    /**
     * Represents success, used when an action has completed successfully
     * with no errors
     * @var string
     */
    const SUCCESS = 'success';

    /**
     * The message for this Alert, this text will be displayed to the user
     * @var string
     */
    private $message;

    /**
     * The Alert constant to represent the style that this alert should
     * take on. Defaults to `Alert::NOTICE`.
     * @var string
     */
    private $type;

    /**
     * Constructor for the Alert class initialises some default
     * variables
     *
     * @param string $message
     *  This text will be displayed to the user
     * @param string $type
     *  The type of alert this is. Defaults to NOTICE, available
     *  values are `Alert::NOTICE`, `Alert::ERROR`, `Alert::SUCCESS`
     */
    public function __construct($message, $type = self::NOTICE)

    {
        $this->message = $message;
        $this->type = $type;
    }

    /**
     * Magic accessor function to get the private variables from
     * an Alert instance
     *
     * @param string $name
     *  The name of the variable, message or type are the valid
     *  values
     * @return string
     */
    public function __get($name)
    {
        return $this->{"$name"};
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
    }

    /**
     * Magic setter function to set the private variables of
     * an Alert instance
     *
     * @param string $name
     *  The name of the variable, message or type are the valid values
     * @param string $value
     *  The value of the variable that is being set
     */
    public function __set($name, $value)
    {
        $this->{"$name"} = $value;
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
    }

    /**
     * Magic isset function to check if a variable is set by ensuring
     * it's not null
     *
     * @param string $name
     *  The name of the variable to check, message or type are the valid
     *  values
     * @return boolean
     *  true when set, false when not set.
     */
    public function __isset($name)
    {
        return isset($this->{"$name"});
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
    }

    /**
     * Generates as XMLElement representation of this Alert
     *
     * @return XMLElement
     */
    public function asXML()
    {
        $p = new XMLElement('p', $this->message, array('role' => 'alert'));
        $p->setAttribute('class', 'notice');

        if ($this->type !== self::NOTICE) {
            $p->setAttribute('class', 'notice ' . $this->type);
        }

        return $p;
    }
}


1			<?php
2			/**
3			* @package toolkit
4			*/
5			/**
6			* The Alert class drives the standard Symphony notices that
7			* appear at the top of the backend pages to alert the user of
8			* something. Their are three default alert styles, notice, error
9			* and success.
10			*/
11			class Alert
12			{
13			/**
14			* Represents a notice, usually used for non blocking alerts,
15			* just to inform that user that something has happened and
16			* they need to aware of it
17			* @var string
18			*/
19			const NOTICE = 'notice';
20
21			/**
22			* Represents an error, used when something has gone wrong during
23			* the previous action. It is blocking, in that the action has
24			* not completed successfully.
25			* @var string
26			*/
27			const ERROR = 'error';
28
29			/**
30			* Represents success, used when an action has completed successfully
31			* with no errors
32			* @var string
33			*/
34			const SUCCESS = 'success';
35
36			/**
37			* The message for this Alert, this text will be displayed to the user
38			* @var string
39			*/
40			private $message;
41
42			/**
43			* The Alert constant to represent the style that this alert should
44			* take on. Defaults to `Alert::NOTICE`.
45			* @var string
46			*/
47			private $type;
48
49			/**
50			* Constructor for the Alert class initialises some default
51			* variables
52			*
53			* @param string $message
54			* This text will be displayed to the user
55			* @param string $type
56			* The type of alert this is. Defaults to NOTICE, available
57			* values are `Alert::NOTICE`, `Alert::ERROR`, `Alert::SUCCESS`
58			*/
59			public function __construct($message, $type = self::NOTICE)
			0 ignored issues – show Coding Style introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report Incorrect spacing between argument "$type" and equals sign; expected 0 but found 1 Loading history... Coding Style introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report Incorrect spacing between default value and equals sign for argument "$type"; expected 0 but found 1 Loading history...
60			{
61			$this->message = $message;
62			$this->type = $type;
63			}
64
65			/**
66			* Magic accessor function to get the private variables from
67			* an Alert instance
68			*
69			* @param string $name
70			* The name of the variable, message or type are the valid
71			* values
72			* @return string
73			*/
74			public function __get($name)
75			{
76			return $this->{"$name"};
			0 ignored issues – show Coding Style Best Practice introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$name` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
77			}
78
79			/**
80			* Magic setter function to set the private variables of
81			* an Alert instance
82			*
83			* @param string $name
84			* The name of the variable, message or type are the valid values
85			* @param string $value
86			* The value of the variable that is being set
87			*/
88			public function __set($name, $value)
89			{
90			$this->{"$name"} = $value;
			0 ignored issues – show Coding Style Best Practice introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$name` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
91			}
92
93			/**
94			* Magic isset function to check if a variable is set by ensuring
95			* it's not null
96			*
97			* @param string $name
98			* The name of the variable to check, message or type are the valid
99			* values
100			* @return boolean
101			* true when set, false when not set.
102			*/
103			public function __isset($name)
104			{
105			return isset($this->{"$name"});
			0 ignored issues – show Coding Style Best Practice introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$name` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
106			}
107
108			/**
109			* Generates as XMLElement representation of this Alert
110			*
111			* @return XMLElement
112			*/
113			public function asXML()
114			{
115			$p = new XMLElement('p', $this->message, array('role' => 'alert'));
116			$p->setAttribute('class', 'notice');
117
118			if ($this->type !== self::NOTICE) {
119			$p->setAttribute('class', 'notice ' . $this->type);
120			}
121
122			return $p;
123			}
124			}
125

symphonycms / symphony-2

GitHub Access Token became invalid

Alert::asXML() A last analyzed 2019-04-08 19:56 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Alert::asXML() A
last analyzed 2019-04-08 19:56 UTC