Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. FileValidationConstraintValidator.php

class FileValidationConstraintValidator

Checks that a file referenced in a file field is valid.

Hierarchy

  • class \Symfony\Component\Validator\ConstraintValidator implements \Symfony\Component\Validator\ConstraintValidatorInterface
    • class \Drupal\file\Plugin\Validation\Constraint\FileValidationConstraintValidator extends \Symfony\Component\Validator\ConstraintValidator implements \Drupal\Core\DependencyInjection\ContainerInjectionInterface

Expanded class hierarchy of FileValidationConstraintValidator

File

core/modules/file/src/Plugin/Validation/Constraint/FileValidationConstraintValidator.php, line 15

Namespace

Drupal\file\Plugin\Validation\Constraint
View source
class FileValidationConstraintValidator extends ConstraintValidator implements ContainerInjectionInterface {
    
    /**
     * Creates a new FileValidationConstraintValidator.
     *
     * @param \Drupal\file\Validation\FileValidatorInterface $fileValidator
     *   The file validator.
     */
    public function __construct(FileValidatorInterface $fileValidator) {
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) : self {
        return new static($container->get('file.validator'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function validate($value, Constraint $constraint) : void {
        // Get the file to execute validators.
        $target = $value->get('entity')
            ->getTarget();
        if (!$target) {
            return;
        }
        $file = $target->getValue();
        // Get the validators.
        $validators = $value->getUploadValidators();
        // Always respect the configured maximum file size.
        $field_settings = $value->getFieldDefinition()
            ->getSettings();
        if (array_key_exists('max_filesize', $field_settings)) {
            $validators['FileSizeLimit'] = [
                'fileLimit' => Bytes::toNumber($field_settings['max_filesize']),
            ];
        }
        else {
            // Do not validate the file size if it is not set explicitly.
            unset($validators['FileSizeLimit']);
        }
        // Checks that a file meets the criteria specified by the validators.
        if ($violations = $this->fileValidator
            ->validate($file, $validators)) {
            foreach ($violations as $violation) {
                $this->context
                    ->addViolation($violation->getMessage());
            }
        }
    }

}

Members

Title Sort descending 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").
FileValidationConstraintValidator::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
FileValidationConstraintValidator::validate public function Checks if the passed value is valid. Overrides ConstraintValidatorInterface::validate
FileValidationConstraintValidator::__construct public function Creates a new FileValidationConstraintValidator.
RSS feed
Powered by Drupal