Function Resource_fs_base->file_load__flat

Definitions

sources/resource_fs_base_class.php

  • Load function for resource-fs (for files). Finds the data for some resource from a resource-fs file.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$filename ID_TEXT No No required parameter N/A N/A Filename
$path string No No required parameter N/A N/A The path (blank: root / not applicable)

Returns

  • Resource data (false: error)
  • Type: ~string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Load function for resource-fs (for files). Finds the data for some resource from a resource-fs file.
 *
 * @param  ID_TEXT $filename Filename
 * @param  string $path The path (blank: root / not applicable)
 * @return ~string Resource data (false: error)
 */
public function file_load__flat(string $filename, string $path)