phpDocumentor\Reflection\File\LocalFile

Complexity

Total Complexity

5

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	2
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.
 *
 * @copyright 2010-2018 Mike van Riel<mike@phpdoc.org>
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\Reflection\File;

use phpDocumentor\Reflection\File;

/**
 * Represents a local file on the file system.
 */
final class LocalFile implements File
{
    /**
     * Path to the file.
     * @var string
     */
    private $path;

    /**
     * LocalFile constructor.
     */
    public function __construct(string $path)
    {
        if (!file_exists($path)) {
            throw new \InvalidArgumentException(sprintf('File "%s" does not exist', $path));
        }

        $this->path = $path;
    }

    /**
     * Returns the content of the file as a string.
     */
    public function getContents(): string
    {
        return (string) file_get_contents($this->path);
    }

    /**
     * Returns md5 hash of the file.
     */
    public function md5(): string
    {
        return md5_file($this->path);
    }

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