Message - Code Metrics - Inspection of "More refactoring." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/implement_pre_connection_j... ( 9bf864...afacc2 )

unknown

created 2020-04-23 02:53 UTC

Message A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

Metric	Value
dl	0
loc	102
rs	10
c	0
b	0
f	0
wmc	5
lcom	2
cbo	0

5 Methods

Rating	Name	Size	Complexity
A	__construct()	14	1
A	render()	10	1
A	show()	6	1
A	message_path()	5	1
A	with_cta()	6	1

<?php
/**
 * Jetpack's JITM Message class.
 *
 * @package automattic/jetpack-jitm
 */

namespace Automattic\Jetpack\JITMS;

/**
 * Class JITM\Message
 *
 * Represents a message the client should display
 */
class Message {
	/**
	 * Message ID
	 *
	 * @var string
	 */
	public $id;

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

	/**
	 * Call to action
	 *
	 * @var string
	 */
	protected $cta;

	/**
	 * Class constructor
	 *
	 * @param string $id Message ID.
	 */
	public function __construct( $id ) {
		$this->id      = $id;
		$this->content = array(

			'message' => '',
			'icon'    => 'jetpack',
			'list'    => array(),
		);
		$this->cta     = array(

			'message'   => '',
			'hook'      => null,
			'newWindow' => false,
			'primary'   => true,
		);
	}

	/**
	 * Renders the internal state to a simple object
	 *
	 * @return \stdClass|bool The simple object
	 */
	public function render() {

		$obj                 = new \stdClass();
		$obj->content        = $this->content;
		$obj->cta            = $this->cta;
		$obj->id             = $this->id;
		$obj->is_dismissible = true;

		return $obj;
	}

	/**
	 * Show the specified message to the user
	 *
	 * @param string $message The message.
	 * @param string $description A longer description that shows up under the message.
	 *
	 * @return $this
	 */
	public function show( $message, $description = '' ) {
		$this->content['message']     = $message;
		$this->content['description'] = $description;

		return $this;
	}

	/**
	 * The message path that needs to match before showing
	 *
	 * @param string $regex The message path regex.
	 *
	 * @return $this
	 */
	public function message_path( $regex ) {
		$this->message_path_regex = $regex;
class MyClass { }

$x = new MyClass();
$x->foo = true;

		return $this;
	}

	/**
	 * A call to action
	 *
	 * @param string $cta The message to display on the CTA button.
	 * @param string $link URL.
	 *
	 * @return $this
	 */
	public function with_cta( $cta, $link = '' ) {
		$this->cta['message'] = $cta;
		$this->cta['link']    = $link;

		return $this;
	}

}


1			<?php
2			/**
3			* Jetpack's JITM Message class.
4			*
5			* @package automattic/jetpack-jitm
6			*/
7
8			namespace Automattic\Jetpack\JITMS;
9
10			/**
11			* Class JITM\Message
12			*
13			* Represents a message the client should display
14			*/
15			class Message {
16			/**
17			* Message ID
18			*
19			* @var string
20			*/
21			public $id;
22
23			/**
24			* Message content
25			*
26			* @var string
27			*/
28			protected $content;
29
30			/**
31			* Call to action
32			*
33			* @var string
34			*/
35			protected $cta;
36
37			/**
38			* Class constructor
39			*
40			* @param string $id Message ID.
41			*/
42			public function __construct( $id ) {
43			$this->id = $id;
44			$this->content = array(
			0 ignored issues – show Documentation Bug introduced 2020-04-23 03:00 UTC by Report Bug Copy Issue Report It seems like `array('message' => '', '...ck', 'list' => array())` of type `array<string,string\|arra...tring","list":"array"}>` is incompatible with the declared type `string` of property `$content`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
45			'message' => '',
46			'icon' => 'jetpack',
47			'list' => array(),
48			);
49			$this->cta = array(
			0 ignored issues – show Documentation Bug introduced 2020-04-23 03:00 UTC by Report Bug Copy Issue Report It seems like `array('message' => '', '...lse, 'primary' => true)` of type `array<string,string\|null...","primary":"boolean"}>` is incompatible with the declared type `string` of property `$cta`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
50			'message' => '',
51			'hook' => null,
52			'newWindow' => false,
53			'primary' => true,
54			);
55			}
56
57			/**
58			* Renders the internal state to a simple object
59			*
60			* @return \stdClass\|bool The simple object
61			*/
62			public function render() {
63
64			$obj = new \stdClass();
65			$obj->content = $this->content;
66			$obj->cta = $this->cta;
67			$obj->id = $this->id;
68			$obj->is_dismissible = true;
69
70			return $obj;
71			}
72
73			/**
74			* Show the specified message to the user
75			*
76			* @param string $message The message.
77			* @param string $description A longer description that shows up under the message.
78			*
79			* @return $this
80			*/
81			public function show( $message, $description = '' ) {
82			$this->content['message'] = $message;
83			$this->content['description'] = $description;
84
85			return $this;
86			}
87
88			/**
89			* The message path that needs to match before showing
90			*
91			* @param string $regex The message path regex.
92			*
93			* @return $this
94			*/
95			public function message_path( $regex ) {
96			$this->message_path_regex = $regex;
			0 ignored issues – show Bug introduced 2020-04-23 03:00 UTC by Report Bug Copy Issue Report The property `message_path_regex` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
97
98			return $this;
99			}
100
101			/**
102			* A call to action
103			*
104			* @param string $cta The message to display on the CTA button.
105			* @param string $link URL.
106			*
107			* @return $this
108			*/
109			public function with_cta( $cta, $link = '' ) {
110			$this->cta['message'] = $cta;
111			$this->cta['link'] = $link;
112
113			return $this;
114			}
115
116			}
117

Automattic / jetpack

Push — add/implement_pre_connection_j... ( 9bf864...afacc2 )

Message A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Duplication Side-by-Side

Filter issues like