class FileEncodingConstraint

Defines an encoding constraint for files.

Hierarchy

  • class \Symfony\Component\Validator\Constraint
    • class \Drupal\file\Plugin\Validation\Constraint\FileEncodingConstraint extends \Symfony\Component\Validator\Constraint

Expanded class hierarchy of FileEncodingConstraint

File

core/modules/file/src/Plugin/Validation/Constraint/FileEncodingConstraint.php, line 14

Namespace

Drupal\file\Plugin\Validation\Constraint
View source 
class FileEncodingConstraint extends SymfonyConstraint {
    
    /**
     * The error message.
     *
     * @var string
     */
    public string $message = "The file is encoded with %detected. It must be encoded with %encoding";
    
    /**
     * The allowed file encodings.
     *
     * @var array
     */
    public array $encodings;

}

Members

Title Modifiers Object type Summary Overrides
Constraint::$groups public property The groups that the constraint belongs to.
Constraint::$payload public property Domain-specific data attached to a constraint.
Constraint::addImplicitGroupName public function Adds the given group if this constraint is in the Default group. 2
Constraint::CLASS_CONSTRAINT public constant Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP public constant The name of the group given to all constraints with no explicit group.
Constraint::ERROR_NAMES protected constant Maps error codes to the names of their constants. 59
Constraint::getDefaultOption public function Returns the name of the default option. 28
Constraint::getErrorName public static function Returns the name of the given error code.
Constraint::getRequiredOptions public function Returns the name of the required options. 22
Constraint::getTargets public function Returns whether the constraint can be put onto classes, properties or
both. 		8
Constraint::normalizeOptions protected function
Constraint::PROPERTY_CONSTRAINT public constant Marks a constraint that can be put onto properties.
Constraint::validatedBy public function Returns the name of the class that validates this constraint. 9
Constraint::__construct public function Initializes the constraint with options. 58
Constraint::__get public function Returns the value of a lazily initialized option. 2
Constraint::__isset public function 1
Constraint::__set public function Sets the value of a lazily initialized option. 1
Constraint::__sleep public function Optimizes the serialized value to minimize storage space.
FileEncodingConstraint::$encodings public property The allowed file encodings.
FileEncodingConstraint::$message public property The error message.