Fusion\Collection\CollectionFactory

Complexity

Total Complexity

5

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	newCollection()	0	3	1
A	newDictionary()	0	3	1
A	newTypedDictionary()	0	3	1
A	newTypedCollection()	0	3	1
A	getValidator()	0	3	1

<?php

/**
 * Part of the Fusion.Collection package.
 *
 * @license MIT
 */

declare(strict_types=1);

namespace Fusion\Collection;

use Fusion\Collection\Contracts\CollectionValidationInterface;
use Fusion\Collection\Exceptions\CollectionException;

/**
 * Factory class to ease instantiation of collection and dictionary objects.
 *
 * @since 2.0.0
 */
class CollectionFactory
{
    private static function getValidator(): CollectionValidationInterface
    {
        return new CollectionValidator();
    }

    /**
     * Creates a new `Collection` with an optional set of starter items.
     *
     * @param array $starterItems
     *
     * @return Collection
     *
     * @throws CollectionException
     * @see \Fusion\Collection\Collection::__construct()
     *
     */
    public static function newCollection(array $starterItems = []): Collection
    {
        return new Collection(self::getValidator(), $starterItems);
    }

    /**
     * Creates a new `TypedCollection` with an optional set of starter items.
     *
     * @param string $acceptedType
     * @param array $starterItems
     *
     * @return TypedCollection
     *
     * @throws CollectionException
     * @see \Fusion\Collection\TypedCollection::__construct()
     *
     */
    public static function newTypedCollection(string $acceptedType, array $starterItems = []): TypedCollection
    {
        return new TypedCollection(self::getValidator(), $acceptedType, $starterItems);
    }

    /**
     * Creates a new `Dictionary` with an optional set of starter items.
     *
     * @param array $starterItems
     *
     * @return Dictionary
     *
     * @throws CollectionException
     * @see \Fusion\Collection\Dictionary::__construct()
     *
     */
    public static function newDictionary(array $starterItems = []): Dictionary
    {
        return new Dictionary(self::getValidator(), $starterItems);
    }

    /**
     * Creates a new `TypedDictionary` with an optional set of starter items.
     *
     * @param string $acceptedType
     * @param array $starterItems
     *
     * @return TypedDictionary
     * @throws CollectionException
     * @see \Fusion\Collection\TypedDictionary::__construct()
     *
     */
    public static function newTypedDictionary(string $acceptedType, array $starterItems = []): TypedDictionary
    {
        return new TypedDictionary(self::getValidator(), $acceptedType, $starterItems);
    }
}