Debian Codegraph @

vendor/ipl/stdlib/src/Messages.php

raw
1 <?php
2
3 namespace ipl\Stdlib;
4
5 /**
6 * Store, retrieve, and manage a list of string messages
7 */
8 trait Messages
9 {
10 /** @var string[] */
11 protected array $messages = [];
12
13 /**
14 * Get whether there are any messages
15 *
16 * @return bool
17 */
18 public function hasMessages(): bool
19 {
20 return ! empty($this->messages);
21 }
22
23 /**
24 * Get all messages
25 *
26 * @return string[]
27 */
28 public function getMessages()
29 {
30 return $this->messages;
31 }
32
33 /**
34 * Set the given messages overriding existing ones
35 *
36 * @param string[] $messages
37 *
38 * @return $this
39 */
40 public function setMessages(array $messages): static
41 {
42 $this->clearMessages();
43
44 foreach ($messages as $message) {
45 $this->addMessage($message);
46 }
47
48 return $this;
49 }
50
51 /**
52 * Add a single message
53 *
54 * @param string $message
55 * @param mixed ...$args Optional args for sprintf-style messages
56 *
57 * @return $this
58 */
59 public function addMessage(string $message, mixed ...$args): static
60 {
61 if (empty($args)) {
62 $this->messages[] = $message;
63 } else {
64 $this->messages[] = vsprintf($message, $args);
65 }
66
67 return $this;
68 }
69
70 /**
71 * Add the given messages
72 *
73 * @param string[] $messages
74 *
75 * @return $this
76 */
77 public function addMessages(array $messages): static
78 {
79 $this->messages = array_merge($this->messages, $messages);
80
81 return $this;
82 }
83
84 /**
85 * Drop any existing message
86 *
87 * @return $this
88 */
89 public function clearMessages(): static
90 {
91 $this->messages = [];
92
93 return $this;
94 }
95 }