phpDocumentor\Parser\FlySystemFile

Complexity

Total Complexity

4

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getContents()	0	4	1
A	md5()	0	4	1
A	path()	0	4	1

<?php
declare(strict_types=1);

/**
 * This file is part of phpDocumentor.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author    Mike van Riel <mike.vanriel@naenius.com>
 * @copyright 2010-2018 Mike van Riel / Naenius (http://www.naenius.com)
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\Parser;

use League\Flysystem\FileNotFoundException;
use League\Flysystem\FilesystemInterface;
use phpDocumentor\Reflection\File;

final class FlySystemFile implements File
{
    /** @var FilesystemInterface */
    private $fileSystem;

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

    public function __construct(FilesystemInterface $fileSystem, string $fileName)
    {
        $this->fileSystem = $fileSystem;
        $this->fileName = $fileName;
    }

    /**
     * Returns the content of the file as a string.
     *
     * @throws FileNotFoundException
     */
    public function getContents(): string
    {
        return $this->fileSystem->read($this->fileName);
    }

    /**
     * Returns md5 hash of the file.
     *
     * @throws FileNotFoundException
     */
    public function md5(): string
    {
        return md5($this->getContents());
    }

    /**
     * Returns an relative path to the file.
     */
    public function path(): string
    {
        return $this->fileName;
    }
}