FilesystemEntity

Complexity

Total Complexity

26

Size/Duplication

Total Lines	130
Duplicated Lines	10.77 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	3
Bugs	0	Features	1

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
A	isLocal()	0	3	1
A	getPath()	0	3	1
A	getServer()	0	3	1
A	setSSHItentityFile()	0	3	1
A	exec()	0	3	1
A	createProcess()	0	10	4
A	upload()	7	7	2
A	uploadContent()	0	3	1
A	download()	7	7	2
A	exists()	0	12	4
A	writeFile()	0	8	2
A	unlink()	0	5	4

<?php

/**
 * An entity on the filesystem, used as a base class for Webroot and SSPakFile
 */
class FilesystemEntity {
	protected $server;
	protected $path;
	protected $executor;
	protected $identity = null;

	function __construct($path, $executor) {

It is generally recommended to explicitly declare the visibility for methods.

		$this->executor = $executor;

		if(strpos($path,':') !== false) {
			list($this->server,$this->path) = explode(':', $path, 2);
		} else {
			$this->server = null;
			$this->path = $path;
		}
	}

	function isLocal() {

It is generally recommended to explicitly declare the visibility for methods.

		return $this->server == null;
	}
	function getPath() {

It is generally recommended to explicitly declare the visibility for methods.

		return $this->path;
	}
	function getServer() {

It is generally recommended to explicitly declare the visibility for methods.

		return $this->server;
	}
	function setSSHItentityFile($filename) {

It is generally recommended to explicitly declare the visibility for methods.

		$this->identity = $filename;
	}

	/**
	 * Execute a command on the relevant server
	 * @param  string $command Shell command, either a fully escaped string or an array
	 */
	function exec($command, $options = array()) {

It is generally recommended to explicitly declare the visibility for methods.

		return $this->createProcess($command, $options)->exec();
	}

	/**
	 * Create a process for later exection
	 * @param  string $command Shell command, either a fully escaped string or an array
	 * @return Process
	 */
	function createProcess($command, $options = array()) {

It is generally recommended to explicitly declare the visibility for methods.

		if($this->server) {
			if ($this->identity && !isset($options['identity'])) {
				$options['identity'] = $this->identity;
			}
			return $this->executor->createRemote($this->server, $command, $options);
		}

		return $this->executor->createLocal($command, $options);
	}

	/**
	 * Upload a file to the given destination on the server
	 * @param string $file The file to upload

There is no parameter named $file. Was it maybe removed?

	 * @param string $dest The remote filename/dir to upload to
	 */
	function upload($source, $dest) {

It is generally recommended to explicitly declare the visibility for methods.

This method seems to be duplicated in your project.

		if($this->server) {
			$this->executor->execLocal(array("scp", $source, "$this->server:$dest"));
		} else {
			$this->executor->execLocal(array("cp", $source, $dest));
		}
	}

	/**
	 * Create a file with the given content at the given destination on the server
	 * @param string $content The content of the file
	 * @param string $dest The remote filename/dir to upload to
	 */
	function uploadContent($content, $dest) {

It is generally recommended to explicitly declare the visibility for methods.

		$this->exec("echo " . escapeshellarg($content) . " > " . escapeshellarg($dest));
	}

	/**
	 * Download a file from the given source on the server to the given file
	 * @param string $source The remote filename to download
	 * @param string $dest The local filename/dir to download to
	 */
	function download($source, $dest) {

It is generally recommended to explicitly declare the visibility for methods.

This method seems to be duplicated in your project.

		if($this->server) {
			$this->executor->execLocal(array("scp", "$this->server:$source", $dest));
		} else {
			$this->executor->execLocal(array("cp", $file, $dest));

The variable $file does not exist. Did you forget to declare it?

		}
	}

	/**
	 * Returns true if the given file or directory exists
	 * @param string $file The file/dir to look for
	 * @return boolean
	 */
	function exists($file = null) {

It is generally recommended to explicitly declare the visibility for methods.

		if(!$file) $file = $this->path;

The expression $file of type string|null is loosely compared to false; this is ambiguous if the string can be empty. You might want to explicitly use === null instead.

		if($file == '@self') return true;

		if($this->server) {
			$result = $this->exec("if [ -e " . escapeshellarg($file) . " ]; then echo yes; fi");
			return (trim($result['output']) == 'yes');

		} else {
			return file_exists($file);
		}
	}

	/**
	 * Create the given file with the given content
	 */
	function writeFile($file, $content) {

It is generally recommended to explicitly declare the visibility for methods.

		if($this->server) {
			$this->exec("echo " . escapeshellarg($content) . " > " . escapeshellarg($file));

		} else {
			file_put_contents($file, $content);
		}
	}

	/**
	 * Remove a file or folder from the webroot's server
	 *
	 * @param string $file The file to remove
	 */
	function unlink($file) {

It is generally recommended to explicitly declare the visibility for methods.

		if(!$file || $file == '/' || $file == '.') throw new Exception("Can't unlink file '$file'");
		$this->exec(array('rm', '-rf', $file));

array('rm', '-rf', $file) is of type array<integer,string,{"0":"string","1":"string","2":"string"}>, but the function expects a string.

		return true;
	}
}