packeta / src / Packetery / Module / Message.php

Message.php in Packeta 1.5.4, at src/Packetery/Module/Message.php

132 lines 1.8 KB

Raw Download Zip

1	<?php
2	/**
3	* Class Message
4	*
5	* @package Packetery\Module
6	*/
7
8	declare( strict_types=1 );
9
10	namespace Packetery\Module;
11
12	/**
13	* Class Message
14	*
15	* @package Packetery\Module
16	*/
17	class Message {
18
19	/**
20	* Message.
21	*
22	* @var string
23	*/
24	private $message = '';
25
26	/**
27	* Type.
28	*
29	* @var string
30	*/
31	private $type = MessageManager::TYPE_SUCCESS;
32
33	/**
34	* Renderer.
35	*
36	* @var string
37	*/
38	private $renderer = MessageManager::RENDERER_WORDPRESS;
39
40	/**
41	* Context.
42	*
43	* @var string
44	*/
45	private $context = '';
46
47	/**
48	* Tells if text should be escaped.
49	*
50	* @var bool
51	*/
52	private $escape = true;
53
54	/**
55	* Creates message.
56	*
57	* @return static
58	*/
59	public static function create(): self {
60	return new self();
61	}
62
63	/**
64	* Sets text.
65	*
66	* @param string $message The message text.
67	*
68	* @return $this
69	*/
70	public function setText( string $message ): self {
71	$this->message = $message;
72	return $this;
73	}
74
75	/**
76	* Sets type.
77	*
78	* @param string $type Type.
79	*
80	* @return $this
81	*/
82	public function setType( string $type ): self {
83	$this->type = $type;
84	return $this;
85	}
86
87	/**
88	* Sets renderer.
89	*
90	* @param string $renderer Renderer.
91	*
92	* @return $this
93	*/
94	public function setRenderer( string $renderer ): self {
95	$this->renderer = $renderer;
96	return $this;
97	}
98
99	/**
100	* Sets context.
101	*
102	* @param string $context Context.
103	*
104	* @return $this
105	*/
106	public function setContext( string $context ): self {
107	$this->context = $context;
108	return $this;
109	}
110
111	/**
112	* Sets escape flag.
113	*
114	* @param bool $escape Tells if message is HTML.
115	*
116	* @return $this
117	*/
118	public function setEscape( bool $escape ): self {
119	$this->escape = $escape;
120	return $this;
121	}
122
123	/**
124	* Converts object to array.
125	*
126	* @return array
127	*/
128	public function toArray(): array {
129	return get_object_vars( $this );
130	}
131	}
132