cs\Storage\_Abstract

Complexity

Total Complexity

4

Size/Duplication

Total Lines	246
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

50%

Importance

Changes	2
Bugs	1	Features	0

19 Methods

Rating	Name	Duplication	Size	Complexity
	__construct()	0	1	?
	file()	0	1	?
	file_get_contents()	0	1	?
	file_put_contents()	0	1	?
	copy()	0	1	?
	unlink()	0	1	?
	file_exists()	0	1	?
	rename()	0	1	?
	mkdir()	0	1	?
	rmdir()	0	1	?
	is_file()	0	1	?
	is_dir()	0	1	?
	url_by_source()	0	1	?
	source_by_url()	0	1	?
A	__clone()	0	2	1
	get_files_list()	0	12	?
A	move_uploaded_file()	0	3	1
A	base_url()	0	3	1
A	connected()	0	3	1

<?php
/**
 * @package   CleverStyle Framework
 * @author    Nazar Mokrynskyi <nazar@mokrynskyi.com>
 * @copyright Copyright (c) 2011-2016, Nazar Mokrynskyi
 * @license   MIT License, see license.txt
 */
namespace cs\Storage;
abstract class _Abstract {
	protected $connected = false;
	protected $base_url  = '';
	/**
	 * Connecting to the Storage
	 *
	 * @param string $base_url
	 * @param string $host
	 * @param string $user
	 * @param string $password
	 */
	abstract public function __construct ($base_url, $host, $user = '', $password = '');

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

	/**
	 * Function for getting content of a directory
	 *
	 * @abstract
	 *
	 * @see get_files_list()
	 *
	 * @param    string        $dir
	 * @param    bool|string   $mask
	 * @param    string        $mode
	 * @param    bool|string   $prefix_path
	 * @param    bool          $subfolders
	 * @param    bool          $sort
	 * @param    bool|string   $exclusion
	 * @param    bool          $system_files
	 * @param    callable|null $apply
	 * @param    int|null      $limit
	 *
	 * @return    array|false
	 */
	abstract public function get_files_list (
		$dir,
		$mask = false,
		$mode = 'f',
		$prefix_path = false,
		$subfolders = false,
		$sort = false,
		$exclusion = false,
		$system_files = false,
		$apply = null,
		$limit = null
	);
	/**
	 * Reads entire file into an array
	 *
	 * @abstract
	 *
	 * @see file()
	 *
	 * @param string   $filename
	 * @param int|null $flags
	 *
	 * @return array|false
	 */
	abstract public function file ($filename, $flags = null);
	/**
	 * Reads entire file into a string
	 *
	 * @abstract
	 *
	 * @see file_get_contents()
	 *
	 * @param string   $filename
	 * @param int|null $flags
	 *
	 * @return false|string
	 */
	abstract public function file_get_contents ($filename, $flags = null);
	/**
	 * Write a string to a file
	 *
	 * @abstract
	 *
	 * @see file_put_contents()
	 *
	 * @param string   $filename
	 * @param string   $data
	 * @param int|null $flags
	 *
	 * @return false|int
	 */
	abstract public function file_put_contents ($filename, $data, $flags = null);
	/**
	 * Copies file
	 *
	 * @abstract
	 *
	 * @see copy()
	 *
	 * @param string $source
	 * @param string $dest
	 *
	 * @return bool
	 */
	abstract public function copy ($source, $dest);
	/**
	 * Deletes a file
	 *
	 * @abstract
	 *
	 * @see unlink()
	 *
	 * @param string $filename
	 *
	 * @return bool
	 */
	abstract public function unlink ($filename);
	/**
	 * Checks whether a file or directory exists
	 *
	 * @abstract
	 *
	 * @see file_exists()
	 *
	 * @param string $filename
	 *
	 * @return bool
	 */
	abstract public function file_exists ($filename);
	/**
	 * @deprecated
	 * @todo Remove in 6.x
	 *
	 * @see static::copy()
	 *
	 * @param string $filename
	 * @param string $destination
	 *
	 * @return bool
	 */
	public function move_uploaded_file ($filename, $destination) {
		return $this->copy($filename, $destination);
	}
	/**
	 * Renames a file or directory
	 *
	 * @abstract
	 *
	 * @see rename()
	 *
	 * @param string $oldname
	 * @param string $newname
	 *
	 * @return bool
	 */
	abstract public function rename ($oldname, $newname);
	/**
	 * Attempts to create the directory specified by pathname.
	 *
	 * @abstract
	 *
	 * @see mkdir()
	 *
	 * @param string $pathname
	 * @param int    $mode
	 * @param bool   $recursive
	 *
	 * @return bool
	 */
	abstract public function mkdir ($pathname, $mode = 0777, $recursive = false);
	/**
	 * Removes directory
	 *
	 * @abstract
	 *
	 * @see rmdir()
	 *
	 * @param string $dirname
	 *
	 * @return bool
	 */
	abstract public function rmdir ($dirname);
	/**
	 * Tells whether the filename is a regular file
	 *
	 * @abstract
	 *
	 * @see is_file()
	 *
	 * @param string $filename
	 *
	 * @return bool
	 */
	abstract public function is_file ($filename);
	/**
	 * Tells whether the filename is a directory
	 *
	 * @abstract
	 *
	 * @see is_dir()
	 *
	 * @param string $filename
	 *
	 * @return bool
	 */
	abstract public function is_dir ($filename);
	/**
	 * Get file url by it's destination in file system
	 *
	 * @abstract
	 *
	 * @see url_by_source()
	 *
	 * @param string $source
	 *
	 * @return false|string
	 */
	abstract public function url_by_source ($source);
	/**
	 * Get file destination in file system by it's url
	 *
	 * @abstract
	 *
	 * @see source_by_url()
	 *
	 * @param string $url
	 *
	 * @return false|string
	 */
	abstract public function source_by_url ($url);
	/**
	 * Return base url of storage
	 *
	 * @return string
	 */
	public function base_url () {
		return $this->base_url;
	}
	/**
	 * Connection state
	 *
	 * @return bool
	 */
	public function connected () {
		return $this->connected;
	}
	/**
	 * Cloning restriction
	 *
	 * @final
	 */
	final protected function __clone () {
	}
}