Jingga/phpOMS
1
0
Fork 0
mirror of https://github.com/Karaka-Management/phpOMS.git synced 2026-01-23 23:08:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Create comments and adjustments

Browse Source 
These changes require changes in the File and Directory class.
This commit is contained in:
Dennis Eichhorn 2016-10-25 14:47:10 +02:00
parent 3500b18997
commit a225921e75
1 changed files with 289 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

294
System/File/ContainerInterface.php
View File

@ -31,53 +31,337 @@ use phpOMS\System\File\Local\FileAbstract;
*/
interface ContainerInterface
{
/**
* Get the datetime when the resource got created.
*
* @param string $path Path of the resource
*
* @return \DateTime
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public static function created(string $path) : \DateTime;
/**
* Get the datetime when the resource got last modified.
*
* @param string $path Path of the resource
*
* @return \DateTime
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public static function changed(string $path) : \DateTime;
/**
* Get the owner id of the resource.
*
* @param string $path Path of the resource
*
* @return int
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public static function owner(string $path) : int;
/**
* Get the permissions id of the resource.
*
* @param string $path Path of the resource
*
* @return int Permissions (e.g. 0644);
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public static function permission(string $path) : int;
/**
* Get the parent path of the resource.
*
* The parent resource path is always a directory.
*
* @param string $path Path of the resource
*
* @return string
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public static function parent(string $path) : string;
/**
* Create resource at destination path.
*
* @param string $path Path of the resource
*
* @return bool True on success and false on failure
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public static function create(string $path) : bool;
/**
* Delete resource at destination path.
*
* @param string $path Path of the resource
*
* @return bool True on success and false on failure
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public static function delete(string $path) : bool;
/**
* Copy resource to different location.
*
* @param string $from Path of the resource to copy
* @param string $to Path of the resource to copy to
* @param bool $overwrite Overwrite/replace existing file
*
* @return bool True on success and false on failure
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public static function copy(string $from, string $to, bool $overwrite = false) : bool;
/**
* Move resource to different location.
*
* @param string $from Path of the resource to move
* @param string $to Path of the resource to move to
* @param bool $overwrite Overwrite/replace existing file
*
* @return bool True on success and false on failure
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public static function move(string $from, string $to, bool $overwrite = false) : bool;
public static function size(string $path) : int;
/**
* Get size of resource.
*
* @param string $path Path of the resource
* @param bool $recursive Should include sub-sub-resources
*
* @return int
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public static function size(string $path, bool $recursive = true) : int;
/**
* Check existence of resource.
*
* @param string $path Path of the resource
*
* @return bool
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public static function exists(string $path) : bool;
public function getCount() : int;
/**
* Get name of resource.
*
* @param string $path Path of the resource
*
* @return string
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public static function name(string $path) : string;
public function getSize() : int;
/**
* Get basename of resource.
*
* @param string $path Path of the resource
*
* @return string
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public static function basename(string $path) : string;
/**
* Get amount of sub-resources.
*
* A file will always return 1 as it doesn't have any sub-resources.
*
* @param string $path Path of the resource
* @param bool $recursive Should count also sub-sub-resources
*
* @return int
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public static function count(string $path, bool $recursive = false) : int;
/**
* Get amount of sub-resources.
*
* A file will always return 1 as it doesn't have any sub-resources.
*
* @param bool $recursive Should count also sub-sub-resources
*
* @return int
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function getCount(bool $recursive = false) : int;
/**
* Get size of resource.
*
* @param bool $recursive Should include sub-sub-resources
*
* @return int
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function getSize(bool $recursive = false) : int;
/**
* Get name of the resource.
*
* @return string
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function getName() : string;
/**
* Get absolute path of the resource.
*
* @return string
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function getPath() : string;
/**
* Get the parent path of the resource.
*
* The parent resource path is always a directory.
*
* @return ContainerInterface
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function getParent() : ContainerInterface;
/**
* Create resource at destination path.
*
* @return bool True on success and false on failure
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function createNode() : bool;
public function copyNode() : bool;
/**
* Copy resource to different location.
*
* @param string $to Path of the resource to copy to
* @param bool $overwrite Overwrite/replace existing file
*
* @return bool True on success and false on failure
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function copyNode(string $to, bool $overwrite = false) : bool;
public function moveNode() : bool;
/**
* Move resource to different location.
*
* @param string $from Path of the resource to move
* @param string $to Path of the resource to move to
* @param bool $overwrite Overwrite/replace existing file
*
* @return bool True on success and false on failure
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function moveNode(string $to, bool $overwrite = false) : bool;
/**
* Delete resource at destination path.
*
* @return bool True on success and false on failure
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function deleteNode() : bool;
/**
* Get the datetime when the resource got created.
*
* @return \DateTime
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function getCreatedAt() : \DateTime;
/**
* Get the datetime when the resource got last modified.
*
* @return \DateTime
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function getChangedAt() : \DateTime;
/**
* Get the owner id of the resource.
*
* @return int
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function getOwner() : int;
/**
* Get the permissions id of the resource.
*
* @return int Permissions (e.g. 0644);
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function getPermission() : string;
/**
* (Re-)Initialize resource
*
* This is used in order to initialize all resources.
* Sub-sub-resources are only initialized once they are needed.
*
* @since 1.0.0
* @author Dennis Eichhorn <d.eichhorn@oms.com>
*/
public function index();
}