summaryrefslogtreecommitdiffstatshomepage
path: root/core/lib/Drupal/Core/Validation/ConstraintViolationBuilder.php
blob: 91dbcbcc98ff085d492ba596d5f0a55145a5d6b4 (plain) (blame)
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
<?php

namespace Drupal\Core\Validation;

// phpcs:ignoreFile Portions of this file are a direct copy of
// \Symfony\Component\Validator\Violation\ConstraintViolationBuilder.

use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintViolation;
use Symfony\Component\Validator\ConstraintViolationList;
use Symfony\Component\Validator\Util\PropertyPath;
use Symfony\Component\Validator\Violation\ConstraintViolationBuilderInterface;

/**
 * A constraint violation builder for the basic Symfony validator.
 *
 * We do not use the builder provided by Symfony as it is marked internal.
 *
 */
class ConstraintViolationBuilder implements ConstraintViolationBuilderInterface {

  /**
   * The number used
   */
  protected ?int $plural = NULL;

  /**
   * The code.
   */
  protected mixed $code = NULL;

  /**
   * The cause.
   */
  protected mixed $cause = NULL;

  /**
   * Constructs a new ConstraintViolationBuilder instance.
   *
   * @param \Symfony\Component\Validator\ConstraintViolationList $violations
   *   The violation list.
   * @param \Symfony\Component\Validator\Constraint $constraint
   *   The constraint.
   * @param string $message
   *   The message.
   * @param array $parameters
   *   The message parameters.
   * @param mixed $root
   *   The root.
   * @param string $propertyPath
   *   The property string.
   * @param mixed $invalidValue
   *   The invalid value.
   * @param \Drupal\Core\Validation\TranslatorInterface $translator
   *   The translator.
   * @param string|false|null $translationDomain
   *   (optional) The translation domain.
   */
  public function __construct(
    protected ConstraintViolationList $violations,
    protected Constraint $constraint,
    protected string $message,
    protected array $parameters,
    protected mixed $root,
    protected string $propertyPath,
    protected mixed $invalidValue,
    protected TranslatorInterface $translator,
    protected string | false | null $translationDomain = NULL
  ) {}

  /**
   * {@inheritdoc}
   */
  public function atPath(string $path): static {
    $this->propertyPath = PropertyPath::append($this->propertyPath, (string) $path);

    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setParameter(string $key, mixed $value): static {
    $this->parameters[$key] = $value;

    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setParameters(array $parameters): static {
    $this->parameters = $parameters;

    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setTranslationDomain(string $translationDomain): static {
    $this->translationDomain = $translationDomain;

    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setInvalidValue(mixed $invalidValue): static {
    $this->invalidValue = $invalidValue;

    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setPlural(int $number): static {
    $this->plural = $number;

    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setCode(?string $code): static {
    $this->code = $code;

    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setCause(mixed $cause): static {
    $this->cause = $cause;

    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function addViolation(): void {
    if (NULL === $this->plural) {
      $translatedMessage = $this->translator->trans(
        $this->message,
        $this->parameters,
        $this->translationDomain
      );
    }
    else {
      try {
        $translatedMessage = $this->translator->transChoice(
          $this->message,
          $this->plural,
          $this->parameters,
          $this->translationDomain#
        );
      }
      catch (\InvalidArgumentException $e) {
        $translatedMessage = $this->translator->trans(
          $this->message,
          $this->parameters,
          $this->translationDomain
        );
      }
    }

    $this->violations->add(new ConstraintViolation(
      $translatedMessage,
      $this->message,
      $this->parameters,
      $this->root,
      $this->propertyPath,
      $this->invalidValue,
      $this->plural,
      $this->code,
      $this->constraint,
      $this->cause
    ));
  }

  /**
   * {@inheritdoc}
   */
  public function disableTranslation(): static {
    $this->translationDomain = FALSE;

    return $this;
  }

}