chillerlan\Filereader\Drivers\DiskDriver

Complexity

Total Complexity

27

Size/Duplication

Total Lines	210
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	fileExists()	0	3	1
A	isFile()	0	3	1
A	isDir()	0	3	1
A	fileContents()	0	8	2
A	getRequire()	0	8	2
A	makeDir()	0	8	2
A	deleteDir()	0	8	2
A	deleteFile()	0	8	2
A	rename()	0	8	4
A	copyFile()	0	8	3
A	write()	0	8	3
A	fileModifyTime()	0	3	1
A	isWritable()	0	8	2
A	findFiles()	0	3	1

<?php
/**
 * Class DiskDriver
 *
 * @filesource   DiskDriver.php
 * @created      02.03.2017
 * @package      chillerlan\Filereader\Drivers
 * @author       Smiley <smiley@chillerlan.net>
 * @copyright    2016 Smiley
 * @license      MIT
 */

namespace chillerlan\Filereader\Drivers;

use chillerlan\Filereader\FilereaderException;
use stdClass;

/**
 *
 */
class DiskDriver implements FSDriverInterface{

	/**
	 * Checks if the given file exists.
	 *
	 * @param string $path the file path
	 *
	 * @return bool
	 */
	public function fileExists(string $path):bool{
		return file_exists($path);
	}

	/**
	 * Checks if the given $path is a file.
	 *
	 * @param string $path the file path
	 *
	 * @return bool
	 */
	public function isFile(string $path):bool{
		return is_file($path);
	}

	/**
	 * Checks if the given $path is a directory.
	 *
	 * @param string $path the directory path
	 *
	 * @return bool
	 */
	public function isDir(string $path):bool{
		return is_dir($path);
	}

	/**
	 * Returns the given file's contents
	 *
	 * @param string $path the file path
	 *
	 * @return string the file's contents
	 * @throws \chillerlan\Filereader\FilereaderException
	 */
	public function fileContents(string $path):string{

		if(!$this->isFile($path)){
			throw new FilereaderException('File not found: '.$path);
		}

		return file_get_contents($path);
	}

	/**
	 * Requires the given source file and returns it's executed contents.
	 * Caution! This is a potential security leak. You could even eval().
	 *
	 * @param string $path the file path
	 *
	 * @return mixed the file's executed contents
	 * @throws \chillerlan\Filereader\FilereaderException
	 */
	public function getRequire(string $path){

		if(!$this->isFile($path)){
			throw new FilereaderException('File not found: '.$path);
		}

		return require $path;
	}

	/**
	 * Creates a new directory under $path.
	 *
	 * @param string $path
	 *
	 * @return bool
	 * @throws \chillerlan\Filereader\FilereaderException
	 */
	public function makeDir(string $path):bool{

		if($this->isDir($path)){
			throw new FilereaderException('Directory already exists: '.$path);
		}

		return mkdir($path);
	}

	/**
	 * Deletes directory $path (if empty)
	 *
	 * @param string $path
	 *
	 * @return bool
	 * @throws \chillerlan\Filereader\FilereaderException
	 */
	public function deleteDir(string $path):bool{

		if(!$this->isDir($path)){
			throw new FilereaderException('Directory not found: '.$path);
		}

		return rmdir($path);
	}

	/**
	 * Deletes a file
	 *
	 * @param string $path
	 *
	 * @return bool
	 * @throws \chillerlan\Filereader\FilereaderException
	 */
	public function deleteFile(string $path):bool{

		if(!$this->isFile($path)){
			throw new FilereaderException('File not found: '.$path);
		}

		return unlink($path);
	}

	/**
	 * Renames a file or directory from $oldname to $newname
	 *
	 * @param string $oldname
	 * @param string $newname
	 * @param bool   $overwrite
	 *
	 * @return bool
	 * @throws \chillerlan\Filereader\FilereaderException
	 */
	public function rename(string $oldname, string $newname, bool $overwrite = true):bool{

		if(!$overwrite && ($this->fileExists($newname) || $this->isDir($newname))){
			throw new FilereaderException('Destination already exists.');
		}

		return rename($oldname, $newname);
	}

	/**
	 * Copies a file from $source to $dest
	 *
	 * @param string $source
	 * @param string $destination
	 * @param bool   $overwrite
	 *
	 * @return bool
	 * @throws \chillerlan\Filereader\FilereaderException
	 */
	public function copyFile(string $source, string $destination, bool $overwrite = true):bool{

		if(!$overwrite && $this->fileExists($destination)){
			throw new FilereaderException('Destination file already exists.');
		}

		return copy($source, $destination);
	}

	/**
	 * @param string $path
	 * @param string $data
	 * @param bool   $overwrite
	 *
	 * @return int|bool
	 * @throws \chillerlan\Filereader\FilereaderException
	 */
	public function write(string $path, string $data, bool $overwrite = true){

		if(!$overwrite && $this->fileExists($path)){
			throw new FilereaderException('Destination file already exists.');
		}

		return file_put_contents($path, $data);
	}

	/**
	 * @param string $path
	 *
	 * @return int|null
	 */
	public function fileModifyTime(string $path):?int{
		return filemtime($path);
	}

	/**
	 * @param string $path
	 *
	 * @return bool
	 * @throws \chillerlan\Filereader\FilereaderException
	 */
	public function isWritable(string $path):bool{

		if(!$this->isDir($path)){
			throw new FilereaderException('Directory not found: '.$path);
		}

		return is_writable($path);
	}

	/**
	 * @param string $pattern
	 *
	 * @return array
	 */
	public function findFiles(string $pattern):array {
		return glob($pattern);
	}

}