Child pages
  • cDirHandler
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

The cDirHandler class encapsules functionalities for dealing with directories.

Methods:

All provided functionalities are in a public static context.

 

Method nameDescriptionExample
 chmod($dirname, $mode)

This method can be used to change directory permissions on a *nix system.

Expected parameters:

  • $dirname: the full path name of a directory
  • $mode: permission you want to set in octal mode

Returns: bool

chmod('/var/www/test/',777);

The call of the method above grants read, write and execute rights.

 create($pathname, $recursive = false)

This method can be used to create a new folder.

Expected parameters:

  • $dirname: the full path name of a directory

Optional parameters:

  • $recursive

Returns: bool

create('/var/www/test/');

The call of the method above create the new folder test.

fileNameIsDot($fileName)

This method checks if the given filename is  '.' or '..'.

Expected parameters:

  • $fileName: the full path name of a file (including the filename)

Returns: bool

In my opinion this method should be transfered to the cFileHandler class, highly recommended!

fileNameIsDot('.');

The call of the method above returns true.

isDirectoryEmpty($dir)

This method returns checks if the given directory is empty.

Expected parameters:

  • $dir: the full path name of a directory

Returns: bool

isDirectoryEmpty('/var/www/test');

The call of the method above returns true if the given directory exists, otherwise false.

move($dirname, $destination)

This method can be used to move a folder to another location.

Expected parameters:

  • $dirname: the full path name of a directory
  • destination: the full path of the new location

Returns: bool

move('/var/www/test/','/var/www/test1/');

The call of the method above grants moves the folder test to folder test1.

read($dirName, $recursive = false, $dirOnly = false)

This method reads the content from given directory.

Expected parameters:

  • $dirName: the full path name of a directory

Optional parameters:

  • $recursive(bool: list recursive)
  • $dirOnly(bool: list only directories)

Returns: bool

read('/var/www/test/');

The call of the method above lists the content of the folder test.

recursiveCopy($filename, $destination)  
recursiveRmdir($dirname)

This method deletes the given folder recursively, that means including all of its subfolders and files.

Expected parameters:

  • $dirname: the full directory path

Returns: bool

recursiveRmdir('/var/www/test/');

The call of the method above deletes the folder test recursively.

remove($dirname)

This method removes the given directory from the filesystem.

Expected parameters:

  • $filename: the full path name of a file (including the filename)

Returns: bool

remove('/var/www/test/');

The call of the method above deletes the folder test.

rename($dirname, $new_dirname)

This method renames the given file from the filesystem.

Expected parameters:

  • $filename: the full path name of a file (including the filename)
  • $new_filename: the full path name of a file (including the filename)

Returns: bool

rename('/var/www/test/','/var/www/test1/');

The call of the method above renames the folder test to test1.

setDefaultDirPerms($dirname)

This method sets default permissions to the given directory

Expected parameters:

  • $pathname: the full path name of a directory

Returns: bool

setDefaultDirPerms('/var/www/test/');

The call of the method sets the default permissions to the the given folder.

  • No labels