IssueCollection.php

<?php

/*
 * This file is part of StaticReview
 *
 * Copyright (c) 2014 Samuel Parkinson <@samparkinson_>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @see http://github.com/sjparkinson/static-review/blob/master/LICENSE.md
 */

namespace StaticReview\Collection;

use StaticReview\Issue\IssueInterface;

class IssueCollection extends Collection
{
    /**
     * Validates that $object is an instance of IssueInterface.
     *
     * @param  IssueInterface           $object
     * @return bool
     * @throws InvalidArgumentException
     */
    public function validate($object)
    {
        if ($object instanceof IssueInterface) {
            return true;
        }

        throw new \InvalidArgumentException($object . ' was not an instance of IssueInterface.');
    }

    /**
     * Filters the collection with the given closure, returning a new collection.
     *
     * @return IssueCollection
     */
    public function select(callable $filter)
    {
        if (! $this->collection) {
            return new IssueCollection();
        }

        $filtered = array_filter($this->collection, $filter);

        return new IssueCollection($filtered);
    }

    /**
     * Returns a new IssueCollection filtered by the given level option.
     *
     * @param  int             $level
     * @return IssueCollection
     */
    public function forLevel($option)
    {
        // Only return issues matching the level.
        $filter = function ($issue) use ($option) {
            if ($issue->matches($option)) {
                return true;
            }

            return false;
        };

        return $this->select($filter);
    }
}