vendor/vich/uploader-bundle/src/Entity/File.php line 5

  1. <?php
  3. namespace Vich\UploaderBundle\Entity;
  5. class File
  6. {
  7.     /**
  8.      * @var string
  9.      */
  10.     protected $name;
  12.     /**
  13.      * @var string
  14.      */
  15.     protected $originalName;
  17.     /**
  18.      * @var string
  19.      */
  20.     protected $mimeType;
  22.     /**
  23.      * @var int
  24.      */
  25.     protected $size;
  27.     /**
  28.      * @var array<int, int>
  29.      */
  30.     protected $dimensions;
  32.     public function getName(): ?string
  33.     {
  34.         return $this->name;
  35.     }
  37.     public function setName(?string $name): void
  38.     {
  39.         $this->name = $name;
  40.     }
  42.     public function getOriginalName(): ?string
  43.     {
  44.         return $this->originalName;
  45.     }
  47.     public function setOriginalName(?string $originalName): void
  48.     {
  49.         $this->originalName = $originalName;
  50.     }
  52.     public function getMimeType(): ?string
  53.     {
  54.         return $this->mimeType;
  55.     }
  57.     public function setMimeType(?string $mimeType): void
  58.     {
  59.         $this->mimeType = $mimeType;
  60.     }
  62.     public function getSize(): ?int
  63.     {
  64.         return $this->size;
  65.     }
  67.     public function setSize(?int $size): void
  68.     {
  69.         $this->size = $size;
  70.     }
  72.     public function getDimensions(): ?array
  73.     {
  74.         return $this->dimensions;
  75.     }
  77.     public function setDimensions(?array $dimensions): void
  78.     {
  79.         $this->dimensions = $dimensions;
  80.     }
  82.     /**
  83.      * A simple shortcut to the image width.
  84.      * Similar to `$file->getDimensions()[0]`.
  85.      *
  86.      * @return int|null Returns `null` if dimensions array is itself null
  87.      */
  88.     public function getWidth(): ?int
  89.     {
  90.         return $this->dimensions[0] ?? null;
  91.     }
  93.     /**
  94.      * A simple shortcut to the image height.
  95.      * Similar to `$file->getDimensions()[1]`.
  96.      *
  97.      * @return int|null Returns `null` if dimensions array is itself null
  98.      */
  99.     public function getHeight(): ?int
  100.     {
  101.         return $this->dimensions[1] ?? null;
  102.     }
  104.     /**
  105.      * Format image dimensions for use with html (to avoid layout shifting).
  106.      *
  107.      * Usage in twig template:
  108.      * ```twig
  109.      * <img src="..." alt="..." {{ image.htmlDimensions|raw }}>
  110.      * <!-- Will render: -->
  111.      * <img src="..." alt="..." width="..." height="...">
  112.      * ```
  113.      *
  114.      * @return string|null Returns `null` if dimensions array is itself null
  115.      */
  116.     public function getHtmlDimensions(): ?string
  117.     {
  118.         if (null !== $this->dimensions) {
  119.             return \sprintf('width="%s" height="%s"', $this->getWidth(), $this->getHeight());
  120.         }
  122.         return null;
  123.     }
  124. }