function drupal_parse_info_file in Drupal 6

Same name and namespace in other branches

1. 7 includes/common.inc \drupal_parse_info_file()

Parse Drupal info file format.

Files should use an ini-like format to specify values. White-space generally doesn't matter, except inside values. e.g.

  key = value
  key = "value"
  key = 'value'
  key = "multi-line

  value"
  key = 'multi-line

  value'
  key
  =
  'value'

Arrays are created using a GET-like syntax:

  key[] = "numeric array"
  key[index] = "associative array"
  key[index][] = "nested numeric array"
  key[index][index] = "nested associative array"

PHP constants are substituted in, but only when used as the entire value:

Comments should start with a semi-colon at the beginning of a line.

This function is NOT for placing arbitrary module-specific settings. Use variable_get() and variable_set() for that.

Information stored in the module.info file:

• name: The real name of the module for display purposes.
• description: A brief description of the module.
• dependencies: An array of shortnames of other modules this module depends on.
• package: The name of the package of modules this module belongs to.

Example of .info file:

  name = Forum
  description = Enables threaded discussions about general topics.
  dependencies[] = taxonomy
  dependencies[] = comment
  package = Core - optional
  version = VERSION

Parameters

$filename: The file we are parsing. Accepts file with relative or absolute path.

Return value

The info array.

4 calls to drupal_parse_info_file()

help_page in modules/help/help.admin.inc

Menu callback; prints a page listing general help for a module.

module_rebuild_cache in includes/module.inc

Rebuild the database cache of module files.

system_modules_uninstall_confirm_form in modules/system/system.admin.inc

Confirm uninstall of selected modules.

_system_theme_data in modules/system/system.module

Helper function to scan and collect theme .info data and their engines.

File

includes/common.inc, line 3704

Common functions that many Drupal modules will need to reference.

Code

function drupal_parse_info_file($filename) {
  $info = array();
  $constants = get_defined_constants();
  if (!file_exists($filename)) {
    return $info;
  }
  $data = file_get_contents($filename);
  if (preg_match_all('
    @^\\s*                           # Start at the beginning of a line, ignoring leading whitespace
    ((?:
      [^=;\\[\\]]|                    # Key names cannot contain equal signs, semi-colons or square brackets,
      \\[[^\\[\\]]*\\]                  # unless they are balanced and not nested
    )+?)
    \\s*=\\s*                         # Key/value pairs are separated by equal signs (ignoring white-space)
    (?:
      ("(?:[^"]|(?<=\\\\)")*")|     # Double-quoted string, which may contain slash-escaped quotes/slashes
      (\'(?:[^\']|(?<=\\\\)\')*\')| # Single-quoted string, which may contain slash-escaped quotes/slashes
      ([^\\r\\n]*?)                   # Non-quoted string
    )\\s*$                           # Stop at the next end of a line, ignoring trailing whitespace
    @msx', $data, $matches, PREG_SET_ORDER)) {
    foreach ($matches as $match) {

      // Fetch the key and value string
      $i = 0;
      foreach (array(
        'key',
        'value1',
        'value2',
        'value3',
      ) as $var) {
        ${$var} = isset($match[++$i]) ? $match[$i] : '';
      }
      $value = stripslashes(substr($value1, 1, -1)) . stripslashes(substr($value2, 1, -1)) . $value3;

      // Parse array syntax
      $keys = preg_split('/\\]?\\[/', rtrim($key, ']'));
      $last = array_pop($keys);
      $parent =& $info;

      // Create nested arrays
      foreach ($keys as $key) {
        if ($key == '') {
          $key = count($parent);
        }
        if (!isset($parent[$key]) || !is_array($parent[$key])) {
          $parent[$key] = array();
        }
        $parent =& $parent[$key];
      }

      // Handle PHP constants.
      if (isset($constants[$value])) {
        $value = $constants[$value];
      }

      // Insert actual value
      if ($last == '') {
        $last = count($parent);
      }
      $parent[$last] = $value;
    }
  }
  return $info;
}