My Ini Design: parse ini file

Uniform Server Cron Configuration

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.

To change values use my_ini_set covered on the previous pages. Combined this with the above function and you have the makings of an easily configurable cron timer.

This page outlines requirements for such a cron timer.

Quick test

Using the previous test set-up. Edit test.php Delete the examples of use section Replace with the following two lines $ini_array = parse_ini_file("cron.ini", true); print_r($ini_array); Note: True: Loads each block as an array (preserves structure) False: Loads everything into a flat array. Any option with a common name are overwritten Run the batch file Run_test.bat Result as shown on the right:

Array ( [moodle] => Array ( [path] => http://localhost/moodle/admin/cron.php [period] => daily [ref] => ) [drupal] => Array ( [path] => http://localhost/drupal/cron.php [period] => daily [ref] => ) [dtdns] => Array ( [path] => ..\..\plugins\dtdns_updater\dtdns_updater.php [period] => hourly [ref] => ) )

Top

Cron Loop

For a Cron loop we need access to the main keys any values we wish to use can be accessed using standard array notation.

Again the foreach function provides a neat solution as the following examples show.

Comment	Code	Results
Code loads file into array Foreach loop scans array Main Keys printed	$ini_array = parse_ini_file("cron.ini", true); foreach($ini_array as $key => $value){ print $key."\n"; }	moodle drupal dtdns
Code loads file into array Foreach loop scans array Main Keys printed Array elements accessed using standard notation Values are printed.	$ini_array = parse_ini_file("cron.ini", true); foreach($ini_array as $key => $value){ print $key."\n"; print $ini_array[$key]['path']." \n"; print $ini_array[$key]['period']." \n"; print $ini_array[$key]['ref']."test\n\n"; }	moodle http://localhost/moodle/admin/cron.php daily test drupal http://localhost/drupal/cron.php daily124 test dtdns ..\..\plugins\dtdns_updater\dtdns_updater.php hourly test Press any key to continue . . .

Top

Issues

When converting static regex patterns to use variables it looks tricky.

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 = "fred123"

• '/$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.

Top

Final Functions

The final functions are shown below and include some example code to show how they can be used.

<?php
//==== Examples of use
if(my_ini_set('cron.ini','drupal','period','daily')){
 print "Update OK\n";
}
else{
 print "Update Failed\n";
}

print my_ini_get('cron.ini','moodle','path')."\n";
//==== End Examples of use

//=== my_ini_set ==============================================================
// Sets an option value in a configuration file
// Inputs:
// $file        Path to file including file name
// $block       Name of block excluding []
// $option      Name of option
// $optionvalue New value of option
// Outputs:
// Returns true on success or false on failure 

function my_ini_set($file,$block,$option,$optionvalue){
 $ini_array = file("$file");                         // Read file into array

 $flag=false;                                        // Set found flag
 foreach($ini_array as $key => $value){              // Scan array line by line

   if($flag &&  preg_match('/^\s*\[/',$value)){      // Is it a new block 
     $flag=false;                                    // Yes: Rest flag
   }

   if(trim($value) == "[$block]"){                   // Is it required block              
     $flag=true;                                     // Yes: set found flag                           
   }
 
   if($flag &&  preg_match("/^\s*$option/",$value)){     // Is required option  
     $ini_array[$key] = "$option = $optionvalue\n";      // Yes save new value
     file_put_contents("$file",$ini_array);              // Save array to file
     return true;                                        // Success return true                           
   }                                                   
 }
 return false;                                           // Option not found
}//end
//=== END my_ini_set ==========================================================


//=== my_ini_get ==============================================================
// Obtains an option value from a configuration file
// Inputs:
// $file        Path to file including file name
// $block       Name of block excluding []
// $option      Name of option
// Outputs:
// Returns  Value on success
// Returns  Blank on failure 

function my_ini_get($file,$block,$option){
 $ini_array = file("$file");                         // Read file into array

 $flag=false;                                        // Set found flag
 foreach($ini_array as $key => $value){              // Scan array line by line

   if($flag &&  preg_match('/^\s*\[/',$value)){      // Is it a new block 
     $flag=false;                                    // Yes: Rest flag                                   
   }

   if(trim($value) == "[$block]"){                   // Is it required block              
     $flag=true;                                     // Yes: set found flag        
   }

   if($flag &&  preg_match("/^\s*$option/",$value)){     // Is required option  
     $str  =  trim($ini_array[$key]);                    // Yes read and clean 
     $str1 =  preg_replace("/^$option\s*=\s*/", "", $str); // Cean 
     return $str1;                                       // Retun option value 
   }                                                   
 }
 return "";                                              // Option not found 
}
//=== END my_ini_get ==========================================================
?>

Top

Summary

Above completes our test code for the second function.

The two snippets of code are proof of concept on the next page these are converted into functions.

Top