Mediact\FileMapping\UnixFileMappingReader

Complexity

Total Complexity

9

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
B	getMappings()	0	28	3
A	rewind()	0	3	1
A	key()	0	3	1
A	next()	0	3	1
A	valid()	0	3	1
A	current()	0	3	1

<?php
/**
 * Copyright Mediact. All rights reserved.
 * https://www.Mediact.nl
 */

namespace Mediact\FileMapping;

use ArrayIterator;
use Iterator;
use SplFileObject;

class UnixFileMappingReader implements FileMappingReaderInterface
{
    /** @var array */
    private $mappingFilePaths;

    /** @var string */
    private $sourceDirectory;

    /** @var string */
    private $targetDirectory;

    /** @var Iterator|FileMappingInterface[] */
    private $mappings;

    /**
     * Constructor.
     *
     * @param string   $sourceDirectory
     * @param string   $targetDirectory
     * @param string[] ...$mappingFilePaths
     */
    public function __construct(
        string $sourceDirectory,
        string $targetDirectory,
        string ...$mappingFilePaths
    ) {
        $this->sourceDirectory  = $sourceDirectory;
        $this->targetDirectory  = $targetDirectory;
        $this->mappingFilePaths = $mappingFilePaths;
    }

    /**
     * Get the mappings.
     *
     * @return Iterator
     */
    private function getMappings(): Iterator
    {
        if ($this->mappings === null) {
            $filePaths = [];

            foreach ($this->mappingFilePaths as $mappingFilePath) {
                $newFilePaths = iterator_to_array(new SplFileObject($mappingFilePath, 'r'));
                $filePaths    = array_merge($filePaths, $newFilePaths);
            }

            $this->mappings = new ArrayIterator(
                array_map(
                    function (string $mapping) : FileMappingInterface {
                        return new UnixFileMapping(
                            $this->sourceDirectory,
                            $this->targetDirectory,
                            trim($mapping)
                        );
                    },
                    // Filter out empty lines.
                    array_filter(
                        $filePaths
                    )
                )
            );
        }

        return $this->mappings;
    }

    /**
     * Move forward to next element.
     *
     * @return void
     */
    public function next()
    {
        $this->getMappings()->next();
    }

    /**
     * Return the key of the current element.
     *
     * @return int
     */
    public function key(): int
    {
        return $this->getMappings()->key();

The expression return $this->getMappings()->key() could return the type string|boolean|double which is incompatible with the type-hinted return integer. Consider adding an additional type-check to rule them out.

    }

    /**
     * Checks if current position is valid.
     *
     * @return bool
     */
    public function valid(): bool
    {
        return $this->getMappings()->valid();
    }

    /**
     * Rewind the Iterator to the first element.
     *
     * @return void
     */
    public function rewind()
    {
        $this->getMappings()->rewind();
    }

    /**
     * Get the current file mapping.
     *
     * @return FileMappingInterface
     */
    public function current(): FileMappingInterface
    {
        return $this->getMappings()->current();

The expression return $this->getMappings()->current() returns the type mixed which includes types incompatible with the type-hinted return Mediact\FileMapping\FileMappingInterface.

    }
}