Redaxscript\Filesystem\File

Complexity

Total Complexity

11

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

95%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	createFile()	0	5	3
A	readFile()	0	9	2
A	renderFile()	0	10	2
A	writeFile()	0	5	2
A	removeFile()	0	5	2

<?php
namespace Redaxscript\Filesystem;

use function chmod;
use function file_get_contents;
use function file_put_contents;
use function is_file;
use function ob_get_clean;
use function ob_start;
use function strlen;
use function touch;
use function unlink;

/**
 * children class to handle a file in the filesystem
 *
 * @since 3.2.0
 *
 * @package Redaxscript
 * @category Filesystem
 * @author Henry Ruhs
 */

class File extends Filesystem
{
	/**
	 * create the file
	 *
	 * @since 3.2.0
	 *
	 * @param string $file name of the file
	 * @param int $mode file access mode
	 *
	 * @return bool
	 */

	public function createFile(string $file = null, int $mode = 0777) : bool
	{
		$path = $this->_root . DIRECTORY_SEPARATOR . $file;
		return !is_file($path) && touch($path) && chmod($path, $mode);
	}

	/**
	 * read content of file
	 *
	 * @since 3.0.0
	 *
	 * @param string $file name of the file
	 *
	 * @return string|null
	 */

	public function readFile(string $file = null) : ?string
	{
		$path = $this->_root . DIRECTORY_SEPARATOR . $file;
		if (is_file($path))
		{
			return file_get_contents($path);
		}
		return null;
	}

	/**
	 * render content of file
	 *
	 * @since 3.0.0
	 *
	 * @param string $file name of the file
	 *
	 * @return string
	 */

	public function renderFile(string $file = null) : string
	{
		$path = $this->_root . DIRECTORY_SEPARATOR . $file;
		ob_start();
		if (is_file($path))
		{
			include($path);
		}
		return ob_get_clean();
	}

	/**
	 * write content to file
	 *
	 * @since 3.0.0
	 *
	 * @param string $file name of the file
	 * @param string $content content of the file
	 *
	 * @return bool
	 */

	public function writeFile(string $file = null, string $content = null) : bool
	{
		$path = $this->_root . DIRECTORY_SEPARATOR . $file;
		return strlen($content) && file_put_contents($path, $content) > 0;
	}

	/**
	 * remove the file
	 *
	 * @since 3.2.0
	 *
	 * @param string $file name of the file
	 *
	 * @return bool
	 */

	public function removeFile(string $file = null) : bool
	{
		$path = $this->_root . DIRECTORY_SEPARATOR . $file;
		return is_file($path) && unlink($path);
	}
}