drupal_parse_info_file
Definition
drupal_parse_info_file($filename)
drupal/includes/common.inc, line 3887
Description
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.
@verbatim key = value key = "value" key = 'value' key = "multi-line
value" key = 'multi-line
value' key = 'value' @endverbatim
Arrays are created using a GET-like syntax:
@verbatim key[] = "numeric array" key[index] = "associative array" key[index][] = "nested numeric array" key[index][index] = "nested associative array" @endverbatim
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.
Parameters
$filename The file we are parsing. Accepts file with relative or absolute path.
Return value
The info array.
Related topics
Name | Description |
|---|---|
| Input validation | Functions to validate user input. |
Code
function drupal_parse_info_file($filename) {
$info = array();
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 (defined($value)) {
$value = constant($value);
}
// Insert actual value
if ($last == '') {
$last = count($parent);
}
$parent[$last] = $value;
}
}
return $info;
}