Phauthentic\Authentication\Authenticator\AuthenticatorCollection

Complexity

Total Complexity

5

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getIterator()	0	3	1
A	__construct()	0	4	2
A	isEmpty()	0	3	1
A	add()	0	3	1

<?php

/**
 * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 * @link          https://cakephp.org CakePHP(tm) Project
 * @since         1.0.0
 * @license       https://opensource.org/licenses/mit-license.php MIT License
 */

declare(strict_types=1);

namespace Phauthentic\Authentication\Authenticator;

use ArrayIterator;
use Traversable;

/**
 * Authenticator Collection
 */
class AuthenticatorCollection implements AuthenticatorCollectionInterface
{
    /**
     * List of authenticators
     *
     * @var \Phauthentic\Authentication\Authenticator\AuthenticatorInterface[]
     */
    protected array $authenticators = [];

    /**
     * Constructor
     *
     * @param iterable<\Phauthentic\Authentication\Authenticator\AuthenticatorInterface> $autheticators Authenticators
     */
    public function __construct(iterable $autheticators = [])
    {
        foreach ($autheticators as $authenticator) {
            $this->add($authenticator);
        }
    }

    /**
     * Returns true if a collection is empty.
     *
     * @return bool
     */
    public function isEmpty(): bool
    {
        return empty($this->authenticators);
    }

    /**
     * {@inheritDoc}
     */
    public function add(AuthenticatorInterface $authenticator): void
    {
        $this->authenticators[] = $authenticator;
    }

    /**
     * Retrieve an external iterator
     *
     * @link http://php.net/manual/en/iteratoraggregate.getiterator.php
     * @return Traversable<\Phauthentic\Authentication\Authenticator\AuthenticatorInterface>
     */
    public function getIterator(): Traversable
    {
        return new ArrayIterator($this->authenticators);
    }
}