Compolomus\FSHelper\PathFixer

Complexity

Total Complexity

6

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	fix()	0	3	1
A	getTrimLength()	0	3	1
A	__construct()	0	4	1
A	getPath()	0	3	1
A	execute()	0	15	2

<?php

declare(strict_types=1);

namespace Compolomus\FSHelper;

use Compolomus\FSHelper\Exceptions\PathNotFoundException;

class PathFixer
{
    /**
     * Absolute or relative path
     *
     * @var string
     */
    private string $path;

    /**
     * Amount of symbols which can be removed from provided path
     *
     * @var int
     */
    private int $trimLength;

    /**
     * PathFixer constructor.
     *
     * @param string $path
     *
     * @throws \Compolomus\FSHelper\Exceptions\PathNotFoundException
     */
    public function __construct(string $path)
    {
        $this->path = $path;
        $this->execute();
    }

    /**
     * Provided path processing
     *
     * @throws \Compolomus\FSHelper\Exceptions\PathNotFoundException
     */
    private function execute(): void
    {
        // Get rale path from provided path (because it can be relative)
        $real = realpath($this->path);

        // Throw an exception if the path does not exist
        if (!$real) {
            throw new PathNotFoundException($this->path);
        }

        // Get directory name by provided real path
        $base = basename($real);

        // Calculate trimmed length between real path and directory only
        $this->trimLength = mb_strlen($real) - mb_strlen($base);
    }

    /**
     * Remove required amount of characters from start of provided path
     *
     * @param string $path
     *
     * @return string
     */
    public function fix(string $path): string
    {
        return mb_substr($path, $this->trimLength);
    }

    /**
     * Return path added via constructor
     *
     * @return string
     */
    public function getPath(): string
    {
        return $this->path;
    }

    /**
     * Return amount of symbols which will be trimmed
     *
     * @return int
     */
    public function getTrimLength(): int
    {
        return $this->trimLength;
    }
}