My Ini Design: parse ini file: Difference between revisions
My Ini Design: parse ini file (view source)
Revision as of 01:13, 24 November 2010
, 24 November 2010no edit summary
(New page: {{Nav My Ini Design}} PHP’s parse_ini_file function allows you to read the content of an ini-file into an array proving easy access to all option values set. The array can be saved back ...) |
Upazixorys (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
=[http://uwujojedeh.co.cc Page Is Unavailable Due To Site Maintenance, Please Visit Reserve Copy Page]= | |||
{{Nav My Ini Design}} | {{Nav My Ini Design}} | ||
PHP’s parse_ini_file function allows you to read the content of an ini-file into an array proving easy access to all option values set. The array can be saved back to a file however all comments will have been stripped. | PHP’s parse_ini_file function allows you to read the content of an ini-file into an array proving easy access to all option values set. The array can be saved back to a file however all comments will have been stripped. | ||
| Line 8: | Line 9: | ||
== Quick test == | == Quick test == | ||
{| | {| | ||
|-valign= | |-valign="top" | ||
| | | | ||
Using the previous test set-up. | Using the previous test set-up. | ||
| Line 18: | Line 19: | ||
|- | |- | ||
| | | | ||
<pre> | |||
$ini_array = parse_ini_file( | $ini_array = parse_ini_file("cron.ini", true); | ||
print_r($ini_array); | print_r($ini_array); | ||
</pre> | |||
|} | |} | ||
''Note'': | ''Note'': | ||
* True: Loads each block as an array (preserves structure) | * True: Loads each block as an array (preserves structure) | ||
* False: Loads everything into a flat array. | * False: Loads everything into a flat array.<br /> Any option with a common name are overwritten | ||
| Line 31: | Line 32: | ||
* Result as shown on the right: | * Result as shown on the right: | ||
| | | | ||
| &nbsp; | ||
| | | | ||
<pre> | |||
Array | Array | ||
( | ( | ||
[moodle] = | [moodle] => Array | ||
( | ( | ||
[path] = | [path] => http://localhost/moodle/admin/cron.php | ||
[period] = | [period] => daily | ||
[ref] = | [ref] => | ||
) | ) | ||
[drupal] = | [drupal] => Array | ||
( | ( | ||
[path] = | [path] => http://localhost/drupal/cron.php | ||
[period] = | [period] => daily | ||
[ref] = | [ref] => | ||
) | ) | ||
[dtdns] = | [dtdns] => Array | ||
( | ( | ||
[path] = | [path] => ..\..\plugins\dtdns_updater\dtdns_updater.php | ||
[period] = | [period] => hourly | ||
[ref] = | [ref] => | ||
) | ) | ||
) | ) | ||
</pre> | |||
|} | |} | ||
'''''[[#top | Top]]''''' | '''''[[#top | Top]]''''' | ||
| Line 63: | Line 64: | ||
Again the foreach function provides a neat solution as the following examples show. | Again the foreach function provides a neat solution as the following examples show. | ||
{| | {| | ||
|-valign= | |-valign="top" | ||
|'''''Comment''''' | |'''''Comment''''' | ||
|'''''Code''''' | |'''''Code''''' | ||
|'''''Results''''' | |'''''Results''''' | ||
|-valign= | |-valign="top" | ||
| | | | ||
* Code loads file into array | * Code loads file into array | ||
| Line 73: | Line 74: | ||
* Main Keys printed | * Main Keys printed | ||
| | | | ||
<pre> | |||
$ini_array = parse_ini_file( | $ini_array = parse_ini_file("cron.ini", true); | ||
foreach($ini_array as $key = | foreach($ini_array as $key => $value){ | ||
print $key. | print $key."\n"; | ||
} | } | ||
</pre> | |||
| | | | ||
<pre> | |||
moodle | moodle | ||
drupal | drupal | ||
dtdns | dtdns | ||
</pre> | |||
|-valign= | |-valign="top" | ||
| | | | ||
* Code loads file into array | * Code loads file into array | ||
* Foreach loop scans array | * Foreach loop scans array | ||
* Main Keys printed | * Main Keys printed | ||
* Array elements accessed | * Array elements accessed<br />using standard notation | ||
* Values are printed. | * Values are printed. | ||
| | | | ||
<pre> | |||
$ini_array = parse_ini_file( | $ini_array = parse_ini_file("cron.ini", true); | ||
foreach($ini_array as $key = | foreach($ini_array as $key => $value){ | ||
print $key. | print $key."\n"; | ||
print $ini_array[$key]['path']. | print $ini_array[$key]['path']." \n"; | ||
print $ini_array[$key]['period']. | print $ini_array[$key]['period']." \n"; | ||
print $ini_array[$key]['ref']. | print $ini_array[$key]['ref']."test\n\n"; | ||
} | } | ||
</pre> | |||
| | | | ||
<pre> | |||
moodle | moodle | ||
http://localhost/moodle/admin/cron.php | http://localhost/moodle/admin/cron.php | ||
| Line 120: | Line 121: | ||
Press any key to continue . . . | Press any key to continue . . . | ||
</pre> | |||
|} | |} | ||
| Line 131: | Line 132: | ||
In reality its quite simple anything enclosed in single quotes is treated by PHP as being literal (use as seen). If enclosed in double quotes PHP replaces all variables with their current value. | In reality its quite simple anything enclosed in single quotes is treated by PHP as being literal (use as seen). If enclosed in double quotes PHP replaces all variables with their current value. | ||
Assume $option = | Assume $option = "fred123" | ||
*''''/$option/'''' The resulting regex pattern is '''/$option/''' | *''''/$option/'''' The resulting regex pattern is '''/$option/''' | ||
*''' | *'''"/$option/"''' The resulting regex pattern is '''/fred123/''' | ||
'''''Note'':''' The two slashes '''//''' are delimiters effectively saying this is a regex pattern. | '''''Note'':''' The two slashes '''//''' are delimiters effectively saying this is a regex pattern. | ||
| Line 140: | Line 141: | ||
== Final Functions == | == Final Functions == | ||
The final functions are shown below and include some example code to show how they can be used. | The final functions are shown below and include some example code to show how they can be used. | ||
<pre> | |||
<?php | |||
//==== Examples of use | //==== Examples of use | ||
if(my_ini_set('cron.ini','drupal','period','daily')){ | if(my_ini_set('cron.ini','drupal','period','daily')){ | ||
print | print "Update OK\n"; | ||
} | } | ||
else{ | else{ | ||
print | print "Update Failed\n"; | ||
} | } | ||
print my_ini_get('cron.ini','moodle','path'). | print my_ini_get('cron.ini','moodle','path')."\n"; | ||
//==== End Examples of use | //==== End Examples of use | ||
| Line 164: | Line 165: | ||
function my_ini_set($file,$block,$option,$optionvalue){ | function my_ini_set($file,$block,$option,$optionvalue){ | ||
$ini_array = file( | $ini_array = file("$file"); // Read file into array | ||
$flag=false; // Set found flag | $flag=false; // Set found flag | ||
foreach($ini_array as $key = | foreach($ini_array as $key => $value){ // Scan array line by line | ||
if($flag && preg_match('/^\s*\[/',$value)){ // Is it a new block | if($flag && preg_match('/^\s*\[/',$value)){ // Is it a new block | ||
$flag=false; // Yes: Rest flag | $flag=false; // Yes: Rest flag | ||
} | } | ||
if(trim($value) == | if(trim($value) == "[$block]"){ // Is it required block | ||
$flag=true; // Yes: set found flag | $flag=true; // Yes: set found flag | ||
} | } | ||
if($flag && preg_match( | if($flag && preg_match("/^\s*$option/",$value)){ // Is required option | ||
$ini_array[$key] = | $ini_array[$key] = "$option = $optionvalue\n"; // Yes save new value | ||
file_put_contents( | file_put_contents("$file",$ini_array); // Save array to file | ||
return true; // Success return true | return true; // Success return true | ||
} | } | ||
| Line 199: | Line 200: | ||
function my_ini_get($file,$block,$option){ | function my_ini_get($file,$block,$option){ | ||
$ini_array = file( | $ini_array = file("$file"); // Read file into array | ||
$flag=false; // Set found flag | $flag=false; // Set found flag | ||
foreach($ini_array as $key = | foreach($ini_array as $key => $value){ // Scan array line by line | ||
if($flag && preg_match('/^\s*\[/',$value)){ // Is it a new block | if($flag && preg_match('/^\s*\[/',$value)){ // Is it a new block | ||
$flag=false; // Yes: Rest flag | $flag=false; // Yes: Rest flag | ||
} | } | ||
if(trim($value) == | if(trim($value) == "[$block]"){ // Is it required block | ||
$flag=true; // Yes: set found flag | $flag=true; // Yes: set found flag | ||
} | } | ||
if($flag && preg_match( | if($flag && preg_match("/^\s*$option/",$value)){ // Is required option | ||
$str = trim($ini_array[$key]); // Yes read and clean | $str = trim($ini_array[$key]); // Yes read and clean | ||
$str1 = preg_replace( | $str1 = preg_replace("/^$option\s*=\s*/", "", $str); // Cean | ||
return $str1; // Retun option value | return $str1; // Retun option value | ||
} | } | ||
} | } | ||
return | return ""; // Option not found | ||
} | } | ||
//=== END my_ini_get ========================================================== | //=== END my_ini_get ========================================================== | ||
? | ?> | ||
</pre> | |||
'''''[[#top | Top]]''''' | '''''[[#top | Top]]''''' | ||