Function Commandr_fs->remove_directory

Definitions

sources/commandr_fs.php

  • Remove a directory under the current working directory. Equivalent to Unix "rmdir".
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$directory array No No required parameter N/A N/A The directory-to-remove's path and name

Returns

  • Success?
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Remove a directory under the current working directory. Equivalent to Unix "rmdir".
 *
 * @param  array $directory The directory-to-remove's path and name
 * @return boolean Success?
 */
public function remove_directory(array $directory) : bool