-
Notifications
You must be signed in to change notification settings - Fork 0
/
ConditionErrorMessage.php
123 lines (106 loc) · 3.43 KB
/
ConditionErrorMessage.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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
<?php
declare(strict_types=1);
/*
* This file is part of the RollerworksSearch package.
*
* (c) Sebastiaan Stok <s.stok@rollerscapes.net>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
namespace Rollerworks\Component\Search;
/**
* A ConditionErrorMessage holds an error message,
* produced during processing.
*
* This can be a failed value transformation,
* too deep nesting, or values overflow.
*
* @author Sebastiaan Stok <s.stok@rollerscapes.net>
*/
final class ConditionErrorMessage
{
/**
* @var string
*/
public $path;
/**
* @var string
*/
public $message;
/**
* The template for the error message.
*
* @var string|null
*/
public $messageTemplate;
/**
* The parameters that should be substituted in the message template.
*
* @var array
*/
public $messageParameters;
/**
* The value for error message pluralization.
*
* @var int|null
*/
public $messagePluralization;
public $cause;
/**
* @var string[]
*/
public $translatedParameters;
/**
* Any array key in $messageParameters will be used as a placeholder in
* $messageTemplate.
*
* @param string $path Path of the error, this is dependent
* on the values structure
* @param string $message The translated error message
* @param string|null $messageTemplate The template for the error message
* @param array $messageParameters The parameters that should be
* substituted in the message template
* @param int|null $messagePluralization The value for error message pluralization
* @param mixed $cause The cause of the error
*/
public function __construct(string $path, string $message, ?string $messageTemplate = null, array $messageParameters = [], ?int $messagePluralization = null, $cause = null)
{
$this->path = $path;
$this->message = $message;
$this->messageTemplate = $messageTemplate ?: $message;
$this->messageParameters = $messageParameters;
$this->messagePluralization = $messagePluralization;
$this->cause = $cause;
}
public static function withMessageTemplate(string $path, string $messageTemplate, array $messageParameters = [], ?int $messagePluralization = null, $cause = null): self
{
return new self(
$path,
strtr($messageTemplate, $messageParameters),
$messageTemplate,
$messageParameters,
$messagePluralization,
$cause
);
}
public static function rawMessage(string $path, string $message, $cause = null): self
{
$obj = new self($path, $message, null, [], null, $cause);
$obj->messageTemplate = null; // Mark as untranslated
return $obj;
}
/**
* @param array $translatedParameters An array of parameter names that need
* to be translated prior to there usage
*/
public function setTranslatedParameters(array $translatedParameters): self
{
$this->translatedParameters = $translatedParameters;
return $this;
}
public function __toString(): string
{
return $this->message;
}
}