Function __global->afm_read_file
Definitions
sources/abstract_file_manager.php
- Read a file (not actually over the open AFM connection, but same result: we can do this directly).
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: string
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $path | PATH | No | No | required parameter | N/A | N/A | The path to the file we are reading |
| $bom | boolean | No | No | False | N/A | N/A | Whether to consider the byte-order-mark and do character set conversions |
Returns
- The contents of the file
- Type: string
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Read a file (not actually over the open AFM connection, but same result: we can do this directly).
*
* @param PATH $path The path to the file we are reading
* @param boolean $bom Whether to consider the byte-order-mark and do character set conversions
* @return string The contents of the file
*/
function afm_read_file(string $path, bool $bom = false) : string
* Read a file (not actually over the open AFM connection, but same result: we can do this directly).
*
* @param PATH $path The path to the file we are reading
* @param boolean $bom Whether to consider the byte-order-mark and do character set conversions
* @return string The contents of the file
*/
function afm_read_file(string $path, bool $bom = false) : string