Function Hook_commandr_fs_bin->listing

Definitions

sources/hooks/systems/commandr_fs/bin.php

  • Standard Commandr-fs listing function for commandr_fs hooks.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$meta_dir array No No required parameter N/A N/A The current meta-directory path
$meta_root_node string No No required parameter N/A N/A The root node of the current meta-directory
&$commandr_fs object Yes No required parameter N/A N/A A reference to the Commandr filesystem object

Returns

  • The final directory listing (false: failure)
  • Type: ~array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Standard Commandr-fs listing function for commandr_fs hooks.
 *
 * @param  array $meta_dir The current meta-directory path
 * @param  string $meta_root_node The root node of the current meta-directory
 * @param  object $commandr_fs A reference to the Commandr filesystem object
 * @return ~array The final directory listing (false: failure)
 */
public function listing(array $meta_dir, string $meta_root_node, object &$commandr_fs)