Function Hook_commandr_fs_extended_config__ecom_prods_prices->read_file

Definitions

sources/hooks/systems/commandr_fs_extended_config/ecom_prods_prices.php

  • Standard Commandr-fs file reading 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
$file_name string No No required parameter N/A N/A The file name
&$commandr_fs object Yes No required parameter N/A N/A A reference to the Commandr filesystem object

Returns

  • The file contents (false: failure)
  • Type: ~string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Standard Commandr-fs file reading 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  string $file_name The file name
 * @param  object $commandr_fs A reference to the Commandr filesystem object
 * @return ~string The file contents (false: failure)
 */
public function read_file(array $meta_dir, string $meta_root_node, string $file_name, object &$commandr_fs)