class Image in Zircon Profile 8

@Target({"PROPERTY", "METHOD", "ANNOTATION"})

@author Benjamin Dulau <[e-mail]> @author Bernhard Schussek <[e-mail]>

Hierarchy

• class \Symfony\Component\Validator\Constraint
  • class \Symfony\Component\Validator\Constraints\File
    • class \Symfony\Component\Validator\Constraints\Image

Related topics

Annotations

Annotations for class discovery and metadata description.

1 file declares its use of Image

ImageValidatorTest.php in vendor/symfony/validator/Tests/Constraints/ImageValidatorTest.php

11 string references to 'Image'

aggregator_entity_extra_field_info in core/modules/aggregator/aggregator.module

Implements hook_entity_extra_field_info().

DrupalImage::getButtons in core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalImage.php

Returns the buttons that this plugin provides, along with metadata.

EditorImageDialog::buildForm in core/modules/editor/src/Form/EditorImageDialog.php

field.field.node.article.field_image.yml in core/profiles/standard/config/install/field.field.node.article.field_image.yml

core/profiles/standard/config/install/field.field.node.article.field_image.yml

FormTestFormStateValuesCleanAdvancedForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestFormStateValuesCleanAdvancedForm.php

Form constructor.

... See full list

File

vendor/symfony/validator/Constraints/Image.php, line 21

Namespace

Symfony\Component\Validator\Constraints

class Image extends File {

  // Don't reuse values used in File
  const SIZE_NOT_DETECTED_ERROR = 10;
  const TOO_WIDE_ERROR = 11;
  const TOO_NARROW_ERROR = 12;
  const TOO_HIGH_ERROR = 13;
  const TOO_LOW_ERROR = 14;
  const RATIO_TOO_BIG_ERROR = 15;
  const RATIO_TOO_SMALL_ERROR = 16;
  const SQUARE_NOT_ALLOWED_ERROR = 17;
  const LANDSCAPE_NOT_ALLOWED_ERROR = 18;
  const PORTRAIT_NOT_ALLOWED_ERROR = 19;

  // Include the mapping from the base class
  protected static $errorNames = array(
    self::NOT_FOUND_ERROR => 'NOT_FOUND_ERROR',
    self::NOT_READABLE_ERROR => 'NOT_READABLE_ERROR',
    self::EMPTY_ERROR => 'EMPTY_ERROR',
    self::TOO_LARGE_ERROR => 'TOO_LARGE_ERROR',
    self::INVALID_MIME_TYPE_ERROR => 'INVALID_MIME_TYPE_ERROR',
    self::SIZE_NOT_DETECTED_ERROR => 'SIZE_NOT_DETECTED_ERROR',
    self::TOO_WIDE_ERROR => 'TOO_WIDE_ERROR',
    self::TOO_NARROW_ERROR => 'TOO_NARROW_ERROR',
    self::TOO_HIGH_ERROR => 'TOO_HIGH_ERROR',
    self::TOO_LOW_ERROR => 'TOO_LOW_ERROR',
    self::RATIO_TOO_BIG_ERROR => 'RATIO_TOO_BIG_ERROR',
    self::RATIO_TOO_SMALL_ERROR => 'RATIO_TOO_SMALL_ERROR',
    self::SQUARE_NOT_ALLOWED_ERROR => 'SQUARE_NOT_ALLOWED_ERROR',
    self::LANDSCAPE_NOT_ALLOWED_ERROR => 'LANDSCAPE_NOT_ALLOWED_ERROR',
    self::PORTRAIT_NOT_ALLOWED_ERROR => 'PORTRAIT_NOT_ALLOWED_ERROR',
  );
  public $mimeTypes = 'image/*';
  public $minWidth;
  public $maxWidth;
  public $maxHeight;
  public $minHeight;
  public $maxRatio;
  public $minRatio;
  public $allowSquare = true;
  public $allowLandscape = true;
  public $allowPortrait = true;

  // The constant for a wrong MIME type is taken from the parent class.
  public $mimeTypesMessage = 'This file is not a valid image.';
  public $sizeNotDetectedMessage = 'The size of the image could not be detected.';
  public $maxWidthMessage = 'The image width is too big ({{ width }}px). Allowed maximum width is {{ max_width }}px.';
  public $minWidthMessage = 'The image width is too small ({{ width }}px). Minimum width expected is {{ min_width }}px.';
  public $maxHeightMessage = 'The image height is too big ({{ height }}px). Allowed maximum height is {{ max_height }}px.';
  public $minHeightMessage = 'The image height is too small ({{ height }}px). Minimum height expected is {{ min_height }}px.';
  public $maxRatioMessage = 'The image ratio is too big ({{ ratio }}). Allowed maximum ratio is {{ max_ratio }}.';
  public $minRatioMessage = 'The image ratio is too small ({{ ratio }}). Minimum ratio expected is {{ min_ratio }}.';
  public $allowSquareMessage = 'The image is square ({{ width }}x{{ height }}px). Square images are not allowed.';
  public $allowLandscapeMessage = 'The image is landscape oriented ({{ width }}x{{ height }}px). Landscape oriented images are not allowed.';
  public $allowPortraitMessage = 'The image is portrait oriented ({{ width }}x{{ height }}px). Portrait oriented images are not allowed.';

}

Members

Name	Modifiers	Type	Description	Overrides
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.	1
Constraint::CLASS_CONSTRAINT		constant	Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP		constant	The name of the group given to all constraints with no explicit group.
Constraint::getDefaultOption	public	function	Returns the name of the default option.	18
Constraint::getErrorName	public static	function	Returns the name of the given error code.
Constraint::getRequiredOptions	public	function	Returns the name of the required options.	11
Constraint::getTargets	public	function	Returns whether the constraint can be put onto classes, properties or both.	11
Constraint::PROPERTY_CONSTRAINT		constant	Marks a constraint that can be put onto properties.
Constraint::validatedBy	public	function	Returns the name of the class that validates this constraint.	11
Constraint::__sleep	public	function	Optimizes the serialized value to minimize storage space.
File::$binaryFormat	public	property
File::$disallowEmptyMessage	public	property
File::$maxSize	protected	property
File::$maxSizeMessage	public	property
File::$notFoundMessage	public	property
File::$notReadableMessage	public	property
File::$uploadCantWriteErrorMessage	public	property
File::$uploadErrorMessage	public	property
File::$uploadExtensionErrorMessage	public	property
File::$uploadFormSizeErrorMessage	public	property
File::$uploadIniSizeErrorMessage	public	property
File::$uploadNoFileErrorMessage	public	property
File::$uploadNoTmpDirErrorMessage	public	property
File::$uploadPartialErrorMessage	public	property
File::EMPTY_ERROR		constant
File::INVALID_MIME_TYPE_ERROR		constant
File::normalizeBinaryFormat	private	function
File::NOT_FOUND_ERROR		constant
File::NOT_READABLE_ERROR		constant
File::TOO_LARGE_ERROR		constant
File::__construct	public	function	Initializes the constraint with options. Overrides Constraint::__construct
File::__get	public	function	Returns the value of a lazily initialized option. Overrides Constraint::__get
File::__set	public	function	Sets the value of a lazily initialized option. Overrides Constraint::__set
Image::$allowLandscape	public	property
Image::$allowLandscapeMessage	public	property
Image::$allowPortrait	public	property
Image::$allowPortraitMessage	public	property
Image::$allowSquare	public	property
Image::$allowSquareMessage	public	property
Image::$errorNames	protected static	property	Maps error codes to the names of their constants. Overrides File::$errorNames
Image::$maxHeight	public	property
Image::$maxHeightMessage	public	property
Image::$maxRatio	public	property
Image::$maxRatioMessage	public	property
Image::$maxWidth	public	property
Image::$maxWidthMessage	public	property
Image::$mimeTypes	public	property	Overrides File::$mimeTypes
Image::$mimeTypesMessage	public	property	Overrides File::$mimeTypesMessage
Image::$minHeight	public	property
Image::$minHeightMessage	public	property
Image::$minRatio	public	property
Image::$minRatioMessage	public	property
Image::$minWidth	public	property
Image::$minWidthMessage	public	property
Image::$sizeNotDetectedMessage	public	property
Image::LANDSCAPE_NOT_ALLOWED_ERROR		constant
Image::PORTRAIT_NOT_ALLOWED_ERROR		constant
Image::RATIO_TOO_BIG_ERROR		constant
Image::RATIO_TOO_SMALL_ERROR		constant
Image::SIZE_NOT_DETECTED_ERROR		constant
Image::SQUARE_NOT_ALLOWED_ERROR		constant
Image::TOO_HIGH_ERROR		constant
Image::TOO_LOW_ERROR		constant
Image::TOO_NARROW_ERROR		constant
Image::TOO_WIDE_ERROR		constant