forked from Skillshare/formatphp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMessageRetriever.php
More file actions
82 lines (70 loc) · 2.43 KB
/
MessageRetriever.php
File metadata and controls
82 lines (70 loc) · 2.43 KB
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
70
71
72
73
74
75
76
77
78
79
80
81
82
<?php
/**
* This file is part of formatphp/formatphp
*
* formatphp/formatphp is open source software: you can distribute
* it and/or modify it under the terms of the MIT License
* (the "License"). You may not use this file except in
* compliance with the License.
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied. See the License for the specific language governing
* permissions and limitations under the License.
*
* @copyright Copyright (c) Skillshare, Inc. <https://www.skillshare.com>
* @copyright Copyright (c) FormatPHP Contributors <https://formatphp.dev>
* @license https://opensource.org/licenses/MIT MIT License
*/
declare(strict_types=1);
namespace FormatPHP\Util;
use FormatPHP\DescriptorInterface;
use FormatPHP\Exception\InvalidArgumentException;
use FormatPHP\Exception\MessageNotFoundException;
use FormatPHP\Exception\UnableToGenerateMessageIdException;
use FormatPHP\MessageCollection;
use function sprintf;
/**
* Provides tools for retrieving message strings from collections
*/
trait MessageRetriever
{
use DescriptorIdBuilder;
/**
* Returns a message from the collection for the given descriptor
*
* @throws InvalidArgumentException
* @throws UnableToGenerateMessageIdException
*/
private function getMessageForDescriptor(
MessageCollection $collection,
DescriptorInterface $descriptor
): string {
$messageId = $this->buildMessageId($descriptor);
try {
return $this->getMessageForId($collection, $messageId);
} catch (MessageNotFoundException $exception) {
if ($descriptor->getDefaultMessage() !== null) {
return (string) $descriptor->getDefaultMessage();
}
}
return $messageId;
}
/**
* Returns a message from the collection for the given message ID
*
* @throws MessageNotFoundException
*/
private function getMessageForId(MessageCollection $collection, string $messageId): string
{
$message = $collection[$messageId] ?? null;
if ($message === null) {
throw new MessageNotFoundException(sprintf(
'Unable to find message with ID "%s"',
$messageId,
));
}
return $message->getMessage();
}
}