class FileEncodingConstraintValidator
Validates the file encoding constraint.
Hierarchy
- class \Symfony\Component\Validator\ConstraintValidator implements \Symfony\Component\Validator\ConstraintValidatorInterface
- class \Drupal\file\Plugin\Validation\Constraint\BaseFileConstraintValidator extends \Symfony\Component\Validator\ConstraintValidator
- class \Drupal\file\Plugin\Validation\Constraint\FileEncodingConstraintValidator extends \Drupal\file\Plugin\Validation\Constraint\BaseFileConstraintValidator
- class \Drupal\file\Plugin\Validation\Constraint\BaseFileConstraintValidator extends \Symfony\Component\Validator\ConstraintValidator
Expanded class hierarchy of FileEncodingConstraintValidator
File
-
core/
modules/ file/ src/ Plugin/ Validation/ Constraint/ FileEncodingConstraintValidator.php, line 13
Namespace
Drupal\file\Plugin\Validation\ConstraintView source
class FileEncodingConstraintValidator extends BaseFileConstraintValidator {
/**
* {@inheritdoc}
*/
public function validate(mixed $value, Constraint $constraint) : void {
/** @var \Drupal\file\Entity\FileInterface $file */
$file = $this->assertValueIsFile($value);
if (!$constraint instanceof FileEncodingConstraint) {
throw new UnexpectedTypeException($constraint, FileEncodingConstraint::class);
}
$encodings = $constraint->encodings;
$data = file_get_contents($file->getFileUri());
foreach ($encodings as $encoding) {
$this->validateEncoding($data, $encoding, $constraint);
}
}
/**
* Validates the encoding of the file.
*
* @param string $data
* The file data.
* @param string $encoding
* The encoding to validate.
* @param \Drupal\file\Plugin\Validation\Constraint\FileEncodingConstraint $constraint
* The constraint.
*/
protected function validateEncoding(string $data, string $encoding, FileEncodingConstraint $constraint) : void {
if (mb_check_encoding($data, $encoding)) {
return;
}
$this->context
->addViolation($constraint->message, [
'%encoding' => $encoding,
'%detected' => mb_detect_encoding($data),
]);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
BaseFileConstraintValidator::assertValueIsFile | protected | function | Checks the value is of type FileInterface. | |
ConstraintValidator::$context | protected | property | ||
ConstraintValidator::formatTypeOf | protected | function | Returns a string representation of the type of the value. | |
ConstraintValidator::formatValue | protected | function | Returns a string representation of the value. | |
ConstraintValidator::formatValues | protected | function | Returns a string representation of a list of values. | |
ConstraintValidator::initialize | public | function | Initializes the constraint validator. | Overrides ConstraintValidatorInterface::initialize |
ConstraintValidator::OBJECT_TO_STRING | public | constant | Whether to cast objects with a "__toString()" method to strings. | |
ConstraintValidator::PRETTY_DATE | public | constant | Whether to format {@link \DateTime} objects, either with the {@link \IntlDateFormatter} (if it is available) or as RFC-3339 dates ("Y-m-d H:i:s"). |
|
FileEncodingConstraintValidator::validate | public | function | Checks if the passed value is valid. | Overrides ConstraintValidatorInterface::validate |
FileEncodingConstraintValidator::validateEncoding | protected | function | Validates the encoding of the file. |