aminyazdanpanah / PHP-FFmpeg-video-streaming

src/RepsCollection.php

<?php

/**
 * This file is part of the PHP-FFmpeg-video-streaming package.
 *
 * (c) Amin Yazdanpanah <contact@aminyazdanpanah.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */


namespace Streaming;


class RepsCollection implements \Countable, \IteratorAggregate
{
    /** @return array  */
    private $representations = [];

    /**
     * RepsCollection constructor.
     * @param array $representations
     */
    public function __construct(array $representations = [])
    {
        array_walk($representations, [$this, 'add']);
    }

    /**
     * @return null|Representation
     */
    public function first()
    {
        return reset($this->representations) ?: null;
    }

    /**
     * @return null|Representation
     */
    public function end()
    {
        return end($this->representations) ?: null;
    }

    /**
     * @param RepresentationInterface $representation
     * @return RepsCollection
     */
    public function add(RepresentationInterface $representation)
    {
        array_push($this->representations, $representation);
        return $this;
    }

    /**
     * @return array
     */
    public function all(): array
    {
        return $this->representations;
    }

    /**
     * @return array
     */
    public function keys(): array
    {
        return array_keys($this->representations);
    }

    /**
     * @param $key
     * @param null $default

Are you sure the doc-type for parameter $default is correct as it would always require null to be passed?

     * @return Representation | mixed
     */
    public function get($key, $default = null)
    {
        return $this->representations[$key] ?? $default;
    }

    /**
     * @param callable $func
     */
    public function map(callable $func)
    {
        $this->representations = array_map($func, $this->representations);
    }

    /**
     * count of representations
     */
    public function count(): int
    {
        return count($this->representations);
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator()
    {
        return new \ArrayIterator($this->representations);
    }
}