class UploadedFileConstraintValidator

Constraint validator for uploaded files.

Use FileValidatorInterface for validating file entities.

Hierarchy

Expanded class hierarchy of UploadedFileConstraintValidator

See also

\Drupal\Core\Validation\FileValidatorInterface

File

core/modules/file/src/Validation/Constraint/UploadedFileConstraintValidator.php, line 21

Namespace

Drupal\file\Validation\Constraint
View source 
class UploadedFileConstraintValidator extends ConstraintValidator {
    
    /**
     * {@inheritdoc}
     */
    public function validate(mixed $value, Constraint $constraint) : void {
        if (!$constraint instanceof UploadedFileConstraint) {
            throw new UnexpectedTypeException($constraint, UploadedFileConstraint::class);
        }
        if (!$value instanceof UploadedFile) {
            throw new UnexpectedTypeException($value, UploadedFile::class);
        }
        if ($value->isValid()) {
            return;
        }
        $maxSize = $constraint->maxSize ?? Environment::getUploadMaxSize();
        match ($value->getError()) {    \UPLOAD_ERR_INI_SIZE => $this->context
                ->buildViolation($constraint->uploadIniSizeErrorMessage, [
                '%file' => $value->getClientOriginalName(),
                '%maxsize' => ByteSizeMarkup::create($maxSize),
            ])
                ->setCode((string) \UPLOAD_ERR_INI_SIZE)
                ->addViolation(),
            \UPLOAD_ERR_FORM_SIZE => $this->context
                ->buildViolation($constraint->uploadFormSizeErrorMessage, [
                '%file' => $value->getClientOriginalName(),
                '%maxsize' => ByteSizeMarkup::create($maxSize),
            ])
                ->setCode((string) \UPLOAD_ERR_FORM_SIZE)
                ->addViolation(),
            \UPLOAD_ERR_PARTIAL => $this->context
                ->buildViolation($constraint->uploadPartialErrorMessage, [
                '%file' => $value->getClientOriginalName(),
            ])
                ->setCode((string) \UPLOAD_ERR_PARTIAL)
                ->addViolation(),
            \UPLOAD_ERR_NO_FILE => $this->context
                ->buildViolation($constraint->uploadNoFileErrorMessage, [
                '%file' => $value->getClientOriginalName(),
            ])
                ->setCode((string) \UPLOAD_ERR_NO_FILE)
                ->addViolation(),
            default => $this->context
                ->buildViolation($constraint->uploadErrorMessage, [
                '%file' => $value->getClientOriginalName(),
            ])
                ->setCode((string) $value->getError())
                ->addViolation(),
        
        };
    }

}

Members

Title Modifiers Object type Summary Overriden Title
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").
UploadedFileConstraintValidator::validate public function Checks if the passed value is valid. Overrides ConstraintValidatorInterface::validate