Baleen\Migrations\Repository\AbstractRepository

Complexity

Total Complexity

7

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes	10
Bugs	0	Features	3

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	3
A	getComparator()	0	4	1
A	getMigrationFactory()	0	4	1
	doFetchAll()	0	1	?
A	fetchAll()	0	9	2

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <https://github.com/baleen/migrations>.
 */

namespace Baleen\Migrations\Repository;

use Baleen\Migrations\Exception\RepositoryException;
use Baleen\Migrations\Migration\Factory\FactoryInterface;
use Baleen\Migrations\Migration\Factory\SimpleFactory;
use Baleen\Migrations\Version\Collection\Linked;
use Baleen\Migrations\Version\Comparator\ComparatorInterface;
use Baleen\Migrations\Version\Comparator\IdComparator;

/**
 * Class AbstractRepository.
 *
 * @author Gabriel Somoza <gabriel@strategery.io>
 */
abstract class AbstractRepository implements RepositoryInterface
{
    /**
     * @var FactoryInterface
     */
    private $factory = null;

    /** @var ComparatorInterface */
    private $comparator = null;

    /**
     * AbstractRepository constructor
     *
     * @param FactoryInterface $factory

Should the type for parameter $factory not be null|FactoryInterface?

     * @param ComparatorInterface $comparator

Should the type for parameter $comparator not be null|ComparatorInterface?

     */
    public function __construct(FactoryInterface $factory = null, ComparatorInterface $comparator = null)
    {
        if (null === $factory) {
            $factory = new SimpleFactory();
        }
        $this->factory = $factory;

        if (null === $comparator) {
            $comparator = new IdComparator();
        }
        $this->comparator = $comparator;
    }

    /**
     * @return ComparatorInterface
     */
    final private function getComparator()
    {
        return $this->comparator;
    }

    /**
     * Returns the migration factory. Creates a new SimpleFactory object for it if none was configured.
     *
     * @return FactoryInterface
     */
    final protected function getMigrationFactory()
    {
        return $this->factory;
    }

    /**
     * @inheritdoc
     */
    final public function fetchAll()
    {
        $collection = $this->doFetchAll();
        if (!$collection instanceof Linked) {
            RepositoryException::throwInvalidObjectException($collection, Linked::class);
        }

        return $collection->sort($this->getComparator());
    }

    /**
     * Must fetch all versions available to the repository, load them with their migrations, and return them as a
     * Linked collection. It must use a factory (default or supplied by 'setMigrationFactory()') to instantiate
     * each of the migrations.
     *
     * @return Linked
     */
    abstract protected function doFetchAll();
}