Class cDirHandler
Class for directory handling.
Provides functions for dealing with directories.
Methods summary
public static
boolean
|
#
create( string $pathname, boolean $recursive = false )
Creates a new dir.
Parameters
- $pathname
- the name and path of the new dir
- $recursive
Returns
boolean
Returns true on success or false on failure.
|
public static
boolean
|
#
remove( string $dirname )
Removes a dir from the filesystem
Removes a dir from the filesystem
Parameters
- $dirname
- The path to the directory
Returns
boolean
Returns true on success or false on failure.
Throws
|
public static
boolean
|
#
move( string $dirname, string $destination )
Moves a dir
Parameters
- $dirname
- The path and name of the directory
- $destination
the destination. Note that the dir can also
be renamed in the process of moving it Returns
boolean
Returns true on success or false on failure.
Throws
|
public static
|
#
rename( string $dirname, string $new_dirname )
Renames a dir
Parameters
- $dirname
- the name and path of the dir
- $new_dirname
- the new name of the dir
|
public static
boolean
|
#
chmod( string $dirname, integer $mode )
Changes the dir permissions
Changes the dir permissions
Parameters
- $dirname
- the name and path of the dir
- $mode
- the new access mode : php chmod needs octal value
Returns
boolean
Returns true on success or false on failure.
Throws
|
public static
boolean
|
#
setDefaultDirPerms( string $dirname )
Sets the default directory permissions on the given directory.
Sets the default directory permissions on the given directory.
Parameters
- $dirname
- the name of the directory
Returns
boolean
Returns true on success or false on failure.
|
public static
boolean
|
#
recursiveRmdir( string $dirname )
Deletes a directory and all of its content.
Deletes a directory and all of its content.
Parameters
- $dirname
- the name of the directory which should be deleted
Returns
boolean
Returns true on success or false on failure.
Throws
|
public static
boolean
|
#
recursiveCopy( string $dirname, string $destination )
Copies a directory and all of its subfolders.
Copies a directory and all of its subfolders.
Parameters
- $dirname
- the name and path of the file
- $destination
the destination. Note that existing files get
overwritten Returns
boolean
true on success
Throws
|
public static
boolean
|
#
isDirectoryEmpty( string $dir )
Checks if a directory is empty
Checks if a directory is empty
Parameters
- $dir
- Name of the directory
Returns
boolean
true if the directory is empty
|
public static
mixed
|
#
read( string $dirName, boolean $recursive = false, boolean $dirOnly = false, boolean $fileOnly = false )
This functions reads the content from given directory.
Optionally options are to read the directory recursive or to list only
directories.
This functions reads the content from given directory.
Optionally options are to read the directory recursive or to list only
directories.
Parameters
- $dirName
- directory
- $recursive
- flag to read recursive
- $dirOnly
- flag to list only directories
- $fileOnly
- flag to list only files if $dirOnly is set to false
Returns
mixed
Ambigous multitype: array containing file names as string, false on error
|
public static
boolean
|
#
exists( string $dirname )
Checks if a directory exists
Checks if a directory exists
Parameters
- $dirname
- the name and path of the directory
Returns
boolean
true if the directory exists
|