mkungla / libhowi-filesystem

Commons/SharedMethodsInterface.inc

<?php
/********************************************************************
 * Created by:	Marko Kungla @ OkramLabs on Aug 6, 2012 - 9:58:05
 * Contact:		okramlabs@gmail.com - https://okramlabs.com
 * @copyright:	2015 OkramLabs - https://okramlabs.com
 * @license		MIT
 *
 * Package name:libhowi-filesystem
 * @category	HOWI3
 * @package		libhowi
 * @subpackage	filesystem
 *
 * Lang:		PHP
 * Encoding:	UTF-8
 ********************************************************************
 * Contributors:
 * @author Marko Kungla <okramlabs@gmail.com>
 *           Github: https://github.com/mkungla
 ********************************************************************
 * Comments:
 */
namespace HOWI3\libhowi\Filesystem\Commons;

interface SharedMethodsInterface
{

    /**
     * Gets the current working directory
     *
     * @return string;

The doc-type string; could not be parsed: Expected "|" or "end of type", but got ";" at position 6. (view supported doc-types)

     */
    public function getCwd();

    /**
     * Gets file or directory size
     *
     * For directory it will return directory total size
     *
     * @param string $filename            

Should the type for parameter $filename not be false|string?

     * @param string $convert            

Should the type for parameter $convert not be false|string?

     * @return in file / directory size or formated array
     */
    public function getSize($convert = false, $filename = false);

    /**
     * Gets last access time of file
     *
     * @param string $timeformat            

Should the type for parameter $timeformat not be false|string?

     * @param string $filename            

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

     * @return int or formated output
     */
    public function getATime($timeformat = false, $pathname = false);

    /**
     * Gets inode change time of file
     *
     * @param string $timeformat            

Should the type for parameter $timeformat not be false|string?

     * @param string $filename            

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

     * @return int or formated output
     */
    public function getCTime($timeformat = false, $pathname = false);

    /**
     * Gets file modification time
     *
     * @param string $timeformat            

Should the type for parameter $timeformat not be false|string?

     * @param string $filename            

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

     * @return int or formated output
     */
    public function getMTime($timeformat = false, $pathname = false);

    /**
     * Conver to ago
     *
     * @param time $timestamp            
     * @param string $date_format
     *            a | y,m,d,h,i,s
     * @param bool $sfx
     *            short or long representation
     * @param string $ommit_zero

Should the type for parameter $ommit_zero not be boolean|string?

     *            ommit emty values?
     * @param string $ago_single            

Should the type for parameter $ago_single not be boolean|string?

     * @param array $clocale            
     */
    public function ct_ago($timestamp, $date_format = 'y,m,d,h,i,s', $sfx = true, $ommit_zero = true, $ago_single = true, $clocale = []);

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.

    /**
     * Creates an FileObject object of the file.
     *
     * This is useful because FileObject contains additional methods
     * for manipulating the file whereas FileInfo is only useful
     * for gaining information, like whether the file is writable.
     *
     * @param string $open_mode            
     * @param string $use_include_path            

Should the type for parameter $use_include_path not be false|string?

     * @param unknown $context            

Should the type for parameter $context not be unknown|null?

     */
    public function openFile($open_mode = "r", $use_include_path = false, $context = null);

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.

    /**
     * Sets the class used with InfoObject::openFile()
     *
     * @param string $class_name            
     */
    public function setFileClass($class_name = "\HOWI3\libhowi\Filesystem\php5\Objects\FileObject");

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.

    /**
     * Sets the class used with InfoObject::getFileInfo() and SplFileInfo::getPathInfo()
     *
     * @param string $class_name            
     */
    public function setInfoClass($class_name = "\HOWI3\libhowi\Filesystem\php5\Objects\InfoObject");

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.

    /**
     * Gets file owner username
     *
     * @param string $filename            

Should the type for parameter $filename not be false|string?

     * @return string owners username
     */
    public function getOwnerName($filename = false);

    /**
     * Gets file group name
     *
     * @param string $filename            

Should the type for parameter $filename not be false|string?

     * @return string group name
     */
    public function getGroupName($filename = false);

    /**
     * Returns canonicalized absolute pathname
     *
     * @param string $filename            

Should the type for parameter $filename not be false|string?

     * @return string
     */
    public function getRealpath($filename = false);

    /**
     * Returns information about a file path
     *
     * If you supply $filename so you are not calling it on FileObject, InfoObject
     * or DirectoryTreeObject you can specify following flags
     * PATHINFO_DIRNAME, PATHINFO_BASENAME, PATHINFO_EXTENSION or PATHINFO_FILENAME.
     *
     * otherwise it will return FileInfo object fo this items path
     *
     * @param string $filename            

Should the type for parameter $filename not be false|string?

     * @param int $flags            

Should the type for parameter $flags not be false|integer?

     * @return mixed
     */
    public function getPathInfo($filename = false, $flags = false, 
        $class_name = '\HOWI3\libhowi\Filesystem\php5\Objects\InfoObject');

    /**
     * Get path of current Iterator item without filename or
     * Gets the path without filename
     *
     * @return string $path
     */
    public function getPath();

    /**
     * Gets the path to the file
     *
     * @return string $path
     */
    public function getPathname();

    /**
     * Gets file group
     *
     * @param string $filename            

Should the type for parameter $filename not be false|string?

     * @return int group id
     */
    public function getGroup($filename = false);

    /**
     * Gets file owner ID
     *
     * @param string $filename            

Should the type for parameter $filename not be false|string?

     * @return int owners user id
     */
    public function getOwner($filename = false);

    /**
     * Gets item inode
     *
     * @param string $filename            

Should the type for parameter $filename not be false|string?

     * @return int inode
     */
    public function getInode($filename = false);

    /**
     * Returns trailing name component of path
     *
     * Getting the path to a file or directory from current iterator (non dot) position,
     * this function will return the trailing name component. When getBasename is called
     * on Dot the current directory basename is returned instead!
     *
     * @param string $suffix            

Should the type for parameter $suffix not be false|string?

     * @param string $pathname            

Should the type for parameter $pathname not be false|string?

     * @return string Name of given path
     */
    public function getBasename($suffix = false, $pathname = false);

    /**
     * Gets file permissions (non octal)
     *
     * @param string $filename            

Should the type for parameter $filename not be false|string?

     * @return int like 755
     */
    public function getPerms($filename = false);

    /**
     * Gets file type
     *
     * @param string $filename            

Should the type for parameter $filename not be false|string?

     * @return string filetype
     */
    public function getType($filename = false);

    /**
     * Determine if current DirectoryIterator item is '.' or '..'
     * 
     * @return bool
     */
    public function isDot();

    /**
     * whether the file path is an absolute path.
     *
     * @param string $path            

Should the type for parameter $path not be false|string?

     * @return bool
     */
    public function isAbsolute($path = false);

    /**
     * whether the file path is an relative path.
     *
     * @param string $path            

Should the type for parameter $path not be false|string?

     * @return bool
     */
    public function isRelative($path = false);

    /**
     * Is path or directory writable
     *
     * @param string $path            

Should the type for parameter $path not be false|string?

     * @return bool
     */
    public function isWritable($path = false);

    /**
     * Tells whether a file exists and is readable
     *
     * @param string $filename            

Should the type for parameter $filename not be false|string?

     * @return bool
     */
    public function isReadable($filename = false);

    /**
     * Tells whether the filename is a directory
     *
     * @param string $filename            

Should the type for parameter $filename not be false|string?

     * @return bool
     */
    public function isDir($filename = false);

    /**
     * Tells whether the filename is executable
     *
     * @param string $filename            

Should the type for parameter $filename not be false|string?

     * @return bool
     */
    public function isExecutable($filename = false);

    /**
     * Tells whether the filename is a regular file
     *
     * @param string $filename            

Should the type for parameter $filename not be false|string?

     * @return bool
     */
    public function isFile($filename = false);

    /**
     * Tells whether the filename is a symbolic link
     *
     * @param string $filename            

Should the type for parameter $filename not be false|string?

     * @return bool
     */
    public function isLink($filename = false);

    /**
     * Convert any path to absolute
     *
     * @param string $path            

Should the type for parameter $path not be false|string?

     * @return string absolute path
     */
    public function makeAbsolute($path = false);

    /**
     * Does file or directory exist
     *
     * @param string $pathname            

Should the type for parameter $pathname not be false|string?

     * @return bool
     */
    public function exists($pathname = false);

    /**
     * Return file name from path or Gets the file name from object
     *
     * @return array
     */
    public function getFilename($filename = false);

    /**
     * Gets the file extension
     *
     * @return string
     */
    public function getExtension($filename = false);
}