src/App/Model/Content/Media/MediaCollection.php line 25

Open in your IDE?
  1. <?php
  3. namespace App\Model\Content\Media;
  5. /**
  6.  *
  7.  */
  8. final class MediaCollection
  9.     implements
  10.         \ArrayAccess,
  11.         \Countable,
  12.         \Iterator,
  13.         \JsonSerializable
  14. {
  15.     /**
  16.      * @var array|AbstractMedia[]
  17.      */
  18.     protected array $elements;
  20.     /**
  21.      * @param array $elements
  22.      */
  23.     public function __construct(array $elements = [])
  24.     {
  25.         $this->elements = array_map(
  26.             function ($element) {
  27.                 return AbstractMedia::build($element);
  28.             },
  29.             $elements
  30.         );
  31.     }
  33.     /**
  34.      * @return AbstractMedia|null
  35.      */
  36.     public function getFeature(): ?AbstractMedia
  37.     {
  38.         if ( ! $this->elements) {
  39.             return null;
  40.         }
  41.         foreach ($this->elements as $element) {
  42.             if ($element->isFeatured()) {
  43.                 return $element;
  44.             }
  45.         }
  46.         return $this->elements[0];
  47.     }
  49.     /**
  50.      * @param int $max
  51.      * @return array|AbstractMedia[]
  52.      */
  53.     public function getFeatures(int $max = PHP_INT_MAX): array
  54.     {
  55.         $max = max(1, $max);
  56.         if ( ! $this->elements) {
  57.             return [];
  58.         }
  59.         if (($first = $this->getFeature()) === $this->elements[0]) {
  60.             return array_slice($this->elements, 0, $max);
  61.         }
  62.         $features = [
  63.             $first,
  64.         ];
  65.         foreach ($this->elements as $element) {
  66.             if (count($features) >= $max) {
  67.                 break;
  68.             }
  69.             if ($element !== $first) {
  70.                 $features[] = $element;
  71.             }
  72.         }
  73.         return $features;
  74.     }
  76.     /**
  77.      * @return array|AbstractMedia[]
  78.      */
  79.     public function toArray(): array
  80.     {
  81.         return $this->elements;
  82.     }
  84.     /**
  85.      * @return array
  86.      */
  87.     public function jsonSerialize(): array
  88.     {
  89.         return array_map(
  90.             function (AbstractMedia $element) {
  91.                 return $element->jsonSerialize();
  92.             },
  93.             array_values($this->elements)
  94.         );
  95.     }
  97.     /**
  98.      * {@inheritDoc}
  99.      */
  100.     public function offsetExists($offset): bool
  101.     {
  102.         return array_key_exists($offset, $this->elements);
  103.     }
  105.     /**
  106.      * {@inheritDoc}
  107.      */
  108.     public function offsetGet($offset)
  109.     {
  110.         return $this->elements[$offset];
  111.     }
  113.     /**
  114.      * {@inheritDoc}
  115.      */
  116.     public function offsetSet($offset, $value)
  117.     {
  118.         $this->elements[$offset] = ( ! $value instanceof AbstractMedia)
  119.             ? AbstractMedia::build($value)
  120.             : $value;
  121.     }
  123.     /**
  124.      * {@inheritDoc}
  125.      */
  126.     public function offsetUnset($offset)
  127.     {
  128.         unset($this->elements[$offset]);
  129.     }
  131.     /**
  132.      * {@inheritDoc}
  133.      */
  134.     public function count(): int
  135.     {
  136.         return count($this->elements);
  137.     }
  139.     /**
  140.      * {@inheritDoc}
  141.      */
  142.     public function current(): AbstractMedia
  143.     {
  144.         return current($this->elements);
  145.     }
  147.     /**
  148.      * {@inheritDoc}
  149.      */
  150.     public function next(): void
  151.     {
  152.         next($this->elements);
  153.     }
  155.     /**
  156.      * {@inheritDoc}
  157.      */
  158.     public function key(): int
  159.     {
  160.         return key($this->elements);
  161.     }
  163.     /**
  164.      * {@inheritDoc}
  165.      */
  166.     public function valid(): bool
  167.     {
  168.         return isset($this->elements[key($this->elements)]);
  169.     }
  171.     /**
  172.      * {@inheritDoc}
  173.      */
  174.     public function rewind(): void
  175.     {
  176.         reset($this->elements);
  177.     }
  179.     /**
  180.      * @return AbstractMedia|null
  181.      */
  182.     public function first(): ?AbstractMedia
  183.     {
  184.         if ($this->elements) {
  185.             return $this->elements[0];
  186.         }
  187.         return null;
  188.     }
  190.     /**
  191.      * @param AbstractMedia $media
  192.      * @return $this
  193.      */
  194.     public function append(AbstractMedia $media): self
  195.     {
  196.         $this->elements[] = $media;
  197.         return $this;
  198.     }
  199. }