Function Commandr_fs->read_file

Definitions

sources/commandr_fs.php

  • Read a file and return the contents.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$to_read array No No required parameter N/A N/A The file to read

Returns

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

Preview

Code (PHP)

/**
 * Read a file and return the contents.
 *
 * @param  array $to_read The file to read
 * @return ~string The file contents (false: failure)
 */
public function read_file(array $to_read)