Function __global->cms_parse_ini_file_safe

Definitions

sources/files.php

  • Parse a configuration file.Supports locking and character set conversion (using BOMs).
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$path PATH No No required parameter N/A N/A The file path
$process_sections boolean No No False N/A N/A Whether to process sections
$scanner_mode integer No No 0 N/A N/A Any INI_SCANNER_* constant

Returns

  • Map of Ini file data (2d if processed sections) (false: error)
  • Type: ~array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Parse a configuration file.Supports locking and character set conversion (using BOMs).
 *
 * @param  PATH $path The file path
 * @param  boolean $process_sections Whether to process sections
 * @param  integer $scanner_mode Any INI_SCANNER_* constant
 * @return ~array Map of Ini file data (2d if processed sections) (false: error)
 */
function cms_parse_ini_file_safe(string $path, bool $process_sections = false, int $scanner_mode = 0)