Triadev\Leopard\Business\Mapping\Mapper

Complexity

Total Complexity

9

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Test Coverage

Coverage

89.66%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getMappingFiles()	0	7	1
A	run()	0	27	5
A	isMappingAlreadyRun()	0	7	2
A	__construct()	0	8	1

<?php

The PHP open tag does not have a corresponding PHP close tag

namespace Triadev\Leopard\Business\Mapping;

Missing file doc comment

use Illuminate\Filesystem\Filesystem;
use Triadev\Leopard\Contract\Repository\MappingLogRepositoryContract;

class Mapper

Missing class doc comment

{

Opening brace should be on the same line as the declaration for class Mapper

    /** @var Filesystem */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

    private $filesystem;

Private member variable "filesystem" must contain a leading underscore

Expected 1 blank line before member var; 0 found

Private member variable "filesystem" must be prefixed with an underscore

    
    /** @var MappingLogRepositoryContract */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

    private $mappingLogRepository;

Private member variable "mappingLogRepository" must contain a leading underscore

Private member variable "mappingLogRepository" must be prefixed with an underscore

    
    /** @var array */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

    private $mappingLogs;

Private member variable "mappingLogs" must contain a leading underscore

Private member variable "mappingLogs" must be prefixed with an underscore

    
    /**
     * Mapper constructor.
     * @param Filesystem $filesystem

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

Expected 19 spaces after parameter type; 1 found

     * @param MappingLogRepositoryContract $mappingLogRepository

Missing parameter comment

     */
    public function __construct(Filesystem $filesystem, MappingLogRepositoryContract $mappingLogRepository)

Expected 2 blank lines before function; 1 found

This line exceeds maximum limit of 100 characters; contains 107 characters

    {
        $this->filesystem = $filesystem;

Equals sign not aligned with surrounding assignments; expected 11 spaces but found 1 space

        $this->mappingLogRepository = $mappingLogRepository;
    
        $this->mappingLogs = array_map(function ($log) {

The opening parenthesis of a multi-line function call should be the last content on the line.

            return $log['mapping'];
        }, $this->mappingLogRepository->all());

For multi-line function calls, the closing parenthesis should be on a new line.

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    
    /**
     * Run mappings
     *
     * @param string $path

Missing parameter comment

Expected 6 spaces after parameter type; 1 found

     * @param string|null $index

Missing parameter comment

     * @param string|null $type

Missing parameter comment

     *
     * @throws \Throwable

Comment missing for @throws tag in function comment

     */

Missing @return tag in function comment

    public function run(string $path, ?string $index = null, ?string $type = null)

Incorrect spacing between argument "$index" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$index"; expected 0 but found 1

Incorrect spacing between argument "$type" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$type"; expected 0 but found 1

    {
        $mappingFiles = $this->getMappingFiles($path);
        
        sort($mappingFiles);
        
        foreach ($mappingFiles as $mappingFile) {
            if ($this->isMappingAlreadyRun($mappingFile)) {
                continue;
            }
            
            $this->filesystem->requireOnce($path . DIRECTORY_SEPARATOR . $mappingFile . '.php');

Concat operator must not be surrounded by spaces

            
            /** @var Mapping $mapping */

Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead

Block comments must be started with /*

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            $mapping = new $mappingFile();
            
            if ($index) {
                $mapping->setDocumentIndex($index);
            }
            
            if ($type) {
                $mapping->setDocumentType($type);
            }
            
            $mapping->map();
            
            $this->mappingLogRepository->add($mappingFile);
        }

End comment for long condition not found; expected "//end foreach"

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end run()

    
    private function getMappingFiles(string $path): array

Private method name "Mapper::getMappingFiles" must be prefixed with an underscore

Missing function doc comment

    {
        $files = $this->filesystem->glob($path . DIRECTORY_SEPARATOR . '*.php');

Concat operator must not be surrounded by spaces

        
        return array_map(function (string $file) {

The opening parenthesis of a multi-line function call should be the last content on the line.

            return str_replace('.php', '', basename($file));
        }, $files);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getMappingFiles()

    
    private function isMappingAlreadyRun(string $mapping) : bool

Private method name "Mapper::isMappingAlreadyRun" must be prefixed with an underscore

Missing function doc comment

    {
        if (in_array($mapping, $this->mappingLogs)) {
            return true;
        }
        
        return false;
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end isMappingAlreadyRun()

}

Expected //end class

As per coding style, files should not end with a newline character.