cyberinferno\Cabal\Helpers\FileSystem\File

Complexity

Total Complexity

8

Size/Duplication

Total Lines	53
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	validateFormat()	0	4	3
A	validateFileExists()	0	4	2
A	getFileContents()	0	6	2

<?php

namespace cyberinferno\Cabal\Helpers\FileSystem;

use cyberinferno\Cabal\Helpers\Exceptions\FileBadFormatException;
use cyberinferno\Cabal\Helpers\Exceptions\FileNotFoundException;

/**
 * Class File
 *
 * Base class for all file system classes. Has basic file loading and validating methods
 *
 * @package cyberinferno\Cabal\Helpers\FileSystem
 * @author Karthik P
 */
abstract class File
{
    protected $_filePath;
    protected $_fileContents;

    /**
     * File constructor.
     * @param string $filePath
     * @throws FileBadFormatException
     * @throws FileNotFoundException
     */
    public function __construct($filePath)
    {
        $this->_filePath = $filePath;
        $this->validateFileExists();
        $this->validateFormat();
    }

    /**
     * Checks whether the specified file exists
     *
     * @throws FileNotFoundException
     */
    protected function validateFileExists()
    {
        if (file_exists($this->_filePath) === false) {
            throw new FileNotFoundException();
        }
    }

    /**
     * Checks whether the specified file isn't empty
     *
     * @throws FileBadFormatException
     */
    protected function validateFormat()
    {
        if (filesize($this->_filePath) == 0 || $this->getFileContents() === null) {
            throw new FileBadFormatException();
        }
    }

    /**
     * Loads the file contents if not already loaded and returns the same
     *
     * @return null|string
     */
    public function getFileContents()
    {
        if (isset($this->_fileContents) === false) {
            $this->_fileContents = file_get_contents($this->_filePath);
        }
        return $this->_fileContents;
    }
}