vendor/contao/image/src/Picture.php line 45

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6. * This file is part of Contao.
  7. *
  8. * (c) Leo Feyer
  9. *
  10. * @license LGPL-3.0-or-later
  11. */
  13. namespace Contao\Image;
  15. use Contao\Image\Exception\InvalidArgumentException;
  17. class Picture implements PictureInterface
  18. {
  19. /**
  20. * @var array
  21. */
  22. private $img;
  24. /**
  25. * @var array
  26. */
  27. private $sources;
  29. public function __construct(array $img, array $sources)
  30. {
  31. $this->validateSrcAttribute($img);
  32. $this->validateSrcsetAttribute($img);
  34. foreach ($sources as $source) {
  35. $this->validateSrcsetAttribute($source);
  36. }
  38. $this->img = $img;
  39. $this->sources = $sources;
  40. }
  42. /**
  43. * {@inheritdoc}
  44. */
  45. public function getImg(?string $rootDir = null, string $prefix = ''): array
  46. {
  47. if (null === $rootDir) {
  48. trigger_deprecation('contao/image', '1.2', 'Passing NULL as $rootDir is deprecated and will no longer work in version 2.0. Use the getRawImg() method instead.');
  50. if ('' !== $prefix) {
  51. throw new InvalidArgumentException(sprintf('Prefix must no be specified if rootDir is null, given "%s"', $prefix));
  52. }
  54. return $this->img;
  55. }
  57. return $this->buildUrls($this->img, $rootDir, $prefix);
  58. }
  60. /**
  61. * {@inheritdoc}
  62. */
  63. public function getRawImg(): array
  64. {
  65. return $this->img;
  66. }
  68. /**
  69. * {@inheritdoc}
  70. */
  71. public function getSources(?string $rootDir = null, string $prefix = ''): array
  72. {
  73. if (null === $rootDir) {
  74. trigger_deprecation('contao/image', '1.2', 'Passing NULL as $rootDir is deprecated and will no longer work in version 2.0. Use the getRawSources() method instead.');
  76. if ('' !== $prefix) {
  77. throw new InvalidArgumentException(sprintf('Prefix must no be specified if rootDir is null, given "%s"', $prefix));
  78. }
  80. return $this->sources;
  81. }
  83. return array_map(
  84. function ($source) use ($rootDir, $prefix) {
  85. return $this->buildUrls($source, $rootDir, $prefix);
  86. },
  87. $this->sources
  88. );
  89. }
  91. /**
  92. * {@inheritdoc}
  93. */
  94. public function getRawSources(): array
  95. {
  96. return $this->sources;
  97. }
  99. /**
  100. * Converts image objects in an attributes array to URLs.
  101. *
  102. * @param array{src:ImageInterface|null, srcset:list<array{0:ImageInterface, 1:string}>} $img
  103. */
  104. private function buildUrls(array $img, string $rootDir, string $prefix): array
  105. {
  106. if (isset($img['src'])) {
  107. $img['src'] = $img['src']->getUrl($rootDir, $prefix);
  108. }
  110. $img['srcset'] = array_map(
  111. /** @param array{0:ImageInterface, 1:string} $src */
  112. static function (array $src) use ($rootDir, $prefix) {
  113. $src[0] = $src[0]->getUrl($rootDir, $prefix);
  115. return implode(' ', $src);
  116. },
  117. $img['srcset']
  118. );
  120. $img['srcset'] = implode(', ', $img['srcset']);
  122. return $img;
  123. }
  125. /**
  126. * Validates the src attribute.
  127. */
  128. private function validateSrcAttribute(array $img): void
  129. {
  130. if (!isset($img['src'])) {
  131. throw new InvalidArgumentException('Missing src attribute');
  132. }
  134. if (!$img['src'] instanceof ImageInterface) {
  135. throw new InvalidArgumentException('Src must be of type ImageInterface');
  136. }
  137. }
  139. /**
  140. * Validates the srcset attribute.
  141. */
  142. private function validateSrcsetAttribute(array $img): void
  143. {
  144. if (!isset($img['srcset'])) {
  145. throw new InvalidArgumentException('Missing srcset attribute');
  146. }
  148. foreach ($img['srcset'] as $src) {
  149. if (!$src[0] instanceof ImageInterface) {
  150. throw new InvalidArgumentException('Srcsets must be of type ImageInterface');
  151. }
  152. }
  153. }
  154. }