HtaccessFirewall\Filesystem\BuiltInFilesystem

Complexity

Total Complexity

11

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	read()	0	12	3
A	write()	0	13	4
A	exists()	0	4	1
A	readable()	0	4	1
A	writable()	0	4	1

<?php

namespace HtaccessFirewall\Filesystem;

use HtaccessFirewall\Filesystem\Exception\FileNotFoundException;
use HtaccessFirewall\Filesystem\Exception\FileNotReadableException;
use HtaccessFirewall\Filesystem\Exception\FileNotWritableException;

/**
 * Filesystem using PHP's built-in filesystem functions.
 */
class BuiltInFilesystem implements Filesystem
{
    /**
     * @var bool
     */
    private $writeLock;

    /**
     * Initialize BuiltInFilesystem.
     *
     * @param bool $writeLock whether to use a write lock (LOCK_EX).
     */
    public function __construct($writeLock = true)
    {
        $this->writeLock = $writeLock;
    }

    /**
     * Read a file into an array.
     *
     * @param string $file Path to the file.
     *
     * @throws FileNotFoundException
     * @throws FileNotReadableException
     *
     * @return string[]
     */
    public function read($file)
    {
        if (!$this->exists($file)) {
            throw new FileNotFoundException();
        }

        if (!$this->readable($file)) {
            throw new FileNotReadableException();
        }

        return file($file, FILE_IGNORE_NEW_LINES);
    }

    /**
     * Write an array to a file.
     *
     * @param string $file Path to the file.
     * @param string[] $lines Array of lines to write to the file.
     *
     * @throws FileNotFoundException
     * @throws FileNotWritableException
     */
    public function write($file, $lines)
    {
        if (!$this->exists($file)) {
            throw new FileNotFoundException();
        }

        if (!$this->writable($file)) {
            throw new FileNotWritableException();
        }

        $contents = implode(PHP_EOL, $lines);
        file_put_contents($file, $contents, $this->writeLock ? LOCK_EX : 0);
    }

    /**
     * Check whether a file exists.
     *
     * @param string $file Path to the file.
     *
     * @return bool
     */
    public function exists($file)
    {
        return file_exists($file);
    }

    /**
     * Check whether a file exists and is readable.
     *
     * @param string $file Path to the file.
     *
     * @return bool
     */
    public function readable($file)
    {
        return is_readable($file);
    }

    /**
     * Check whether a file exists and is writable.
     *
     * @param string $file Path to the file.
     *
     * @return bool
     */
    public function writable($file)
    {
        return is_writable($file);
    }
}