-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
MessageInterface.php
69 lines (64 loc) · 1.93 KB
/
MessageInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<?php
declare(strict_types=1);
namespace SonsOfPHP\Contract\Cqrs;
use InvalidArgumentException;
use SonsOfPHP\Contract\Cqrs\Exception\CqrsExceptionInterface;
/**
* Both Command and Queries implement the MessageInterface
*
* A Message MUST be:
* - Immutable
* - Able to be serialized. The Message may be processed asynchronously and
* will need to be serialized.
*
* Serializing the message can be done any number of ways and should be left
* up to the developer to implement.
*
* Message may MOST be handled once.
*
* @author Joshua Estes <joshua@sonsofphp.com>
*/
interface MessageInterface
{
/**
* Adds a new value for a given key.
*
* If a value already exists, this will overwrite that value.
*
* If the value for key exists, and the values are equal, this should
* not return a new object.
*
* If the $key is an array, it should be a key => value array and will overwrite
* all the existing values
*
* @param mixed $value
* - If an object is passed in, it must be able to be converted to a
* string. If it's unable to be converted to string, an exception
* is thrown.
*
* @throws InvalidArgumentException
* - If the given key or value is invalid
*
* Examples:
* $message = $message->with('user_id', 42);
* $message = $message->with([
* 'user_id' => 42,
* 'account_id' => 2131,
* ]);
*/
public function with(string|array $key, mixed $value = null): static;
/**
* Returns the value stored for a given key.
*
* If no key is passed in or if null is passed in, it will return
* all the values
*
* @throws CqrsExceptionInterface
* - If the given key is not part of this message
*
* Examples:
* $userId = $message->get('user_id');
* $payload = $message->get();
*/
public function get(?string $key = null): mixed;
}