kalanis\EmailApi\LocalInfo\ServicesOrdering

Complexity

Total Complexity

11

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	next()	0	3	1
A	removeService()	0	4	1
A	mayReturnFirstUnsuccessful()	0	4	1
A	rewind()	0	3	1
A	isReturningAfterFirstUnsuccessful()	0	3	1
A	current()	0	4	2
A	canUseService()	0	3	1
A	key()	0	4	1
A	valid()	0	4	1
A	addService()	0	4	1

<?php

namespace kalanis\EmailApi\LocalInfo;


use Iterator;
use kalanis\EmailApi\Interfaces;


/**
 * Class ServicesOrdering
 * @package kalanis\EmailApi\LocalInfo
 * Default services available on local installation
 * Contains typical PHP object-to-array boilerplate
 * You can extend this class to specify order of available services
 * @implements Iterator<int|null, Interfaces\ISending|null>
 */
class ServicesOrdering implements Iterator
{
    /** @var array<int, Interfaces\ISending> */
    protected array $services = [];
    protected bool $returnOnUnsuccessful = false;

    public function addService(Interfaces\ISending $service): self
    {
        $this->services[$service->systemServiceId()] = $service;
        return $this;
    }

    public function removeService(Interfaces\ISending $service): self
    {
        unset($this->services[$service->systemServiceId()]);
        return $this;
    }

    public function mayReturnFirstUnsuccessful(bool $set = false): self
    {
        $this->returnOnUnsuccessful = $set;
        return $this;
    }

    public function isReturningAfterFirstUnsuccessful(): bool
    {
        return $this->returnOnUnsuccessful;
    }

    public function canUseService(): bool
    {
        return (!empty($this->services));
    }

    #[\ReturnTypeWillChange]
    public function current()
    {
        return (false !== ($service = current($this->services))) ? $service : null;
    }

    public function next(): void
    {
        next($this->services);
    }

    #[\ReturnTypeWillChange]
    public function key()
    {
        return key($this->services);
    }

    public function valid(): bool
    {
        $key = $this->key();
        return !is_null($key);
    }

    public function rewind(): void
    {
        reset($this->services);
    }
}