User Defined File INI on PHP

Vitaly Eremenko

All Scripts

VitFileINI.php
This is PHP4/5 class to create, read and write your personal INI file on the web-server (also on your localhost).
INI file may be placed in any subfolder in the your site root folder.
It may have any name, but it is preferable to use extension INI.
This script does not use specific of PHP5.

Example of usage class: VitFileINI

EXAMPLE:
File: "config/My_Params.INI"
in the folder on the web-server or localhost.
Content of INI-file may be in your Language in UTF-8 codepage.

Content of File: My_Params.INI

[INIT_DATA]
Local Valute Name (Loc.)=rub
Average Rate (Local to $1 USD)=29.6
Tax from Trade Volume % = 6
// comment 1 - script will pass it

[TRADE_DATA]
Rent for 1 m2 of Area (loc./month)=800
// Trade Area m2=32
Trade Area m2=43.5

===================================

How to Create, Read, Write the file My_Params.INI:

require_once "VitFileINI.php";
$obINI = new VitFileINI();
$sFileINI = "config/My_Params.INI";  // set your file folder and name
.....
// LOAD PARAMS from INI:
  $obINI->SetOrCreateFileINI($sFileINI);
  $obINI->ReadParseFileINI();

$obINI->SetCurrentSection("INIT_DATA");   // Section Name without '[]'
  $sMoney  = "USD";  // default calue
  $sMoney  = $obINI->GetValueINI("Local Valute Name (Loc.)", $sMoney);
  $rLocToUSD = 1.0;
  $rLocToUSD = $obINI->GetValueINI("Average Rate (Local to $1 USD)", $rLocToUSD );
  $rTaxOnVol = 5.0; // %
  $rTaxOnVol = $obINI->GetValueINI("Tax from Trade Volume %", $rTaxOnVol);

$obINI->SetCurrentSection("TRADE_DATA");
  $rLocalRentPerM2 = 20.0; // usd/m2
  $rLocalRentPerM2 =
    $obINI->GetValueINI("Rent for 1 m2 of Area (loc./month)", $rLocalRentPerM2);
  $rTradeArea = 10.0; // m2
  $rTradeArea = $obINI->GetValueINI("Trade Area m2", $rTradeArea);
//*** END LOADING

// SAVE PARAMS in INI:
  $obINI->SetOrCreateFileINI($sFileINI);
  $obINI->ReadParseFileINI();

$obINI->SetCurrentSection("INIT_DATA");   // without '[]'
  $obINI->SetValueINI("Local Valute Name (Loc.)", $sMoney);
  $obINI->SetValueINI("Average Rate (Local to $1 USD)", $rLocToUSD );
  $obINI->GetValueINI("Tax from Trade Volume %", $rTaxOnVol);

$obINI->SetCurrentSection("TRADE_DATA");
  $obINI->SetValueINI("Rent for 1 m2 of Area (loc./month)", $rLocalRentPerM2);
  $obINI->SetValueINI("Trade Area m2", $rTradeArea);

$obINI->WriteAllFileINI();

//*** END SAVING
//===========================================================================

Code of File: VitFileINI.php

/*
==========================================
Vitaly Eremenko
Class  VitFileINI
Utilites for user-defined File INI on PHP5.
It works with complex name of parameters and saves comment-lines '//'.
December 2008
www.violtan.com

Term and Conditions:
- Free copy/paste with this title and URL-reference to this site
or its page
- No any warranty for your web-site/application.
You should create object of this class and test it.
- php.ini may be inaccessible for this script due to its place outside of root folder of a site.
============================================
NOTE:
PHP Lib file Function:
array parse_ini_file( string $filename [, bool $process_sections = false
 [, int $scanner_mode = INI_SCANNER_NORMAL ]] )
DOES NOT work correctly for INI file
with complex keys as:
 aaa (bbb)=value
=============================================
Contents:

// Common methods:
VitFileINI();
$bRet = SetFileINI($i_sFileINI);
SetOrCreateFileINI($i_sFileINI);

// Methods For entire file INI:
ReadParseFileINI();
SetCurrentSection($i_sSection);   // without '[', ']'
$nLines = GetNumOfLinesINI();
$bIs = IsKeyINI($i_sKey);
$sValue = GetValueINI($i_sKey, $i_sDefault="");
AddSectionINI($i_sSection);  // witout []
SetValueINI($i_sKey, $i_sValue);
WriteAllFileINI();

// Methods for ONE key=value:
$niLine = ReadOneKey($i_sSection, $i_sKey, &$o_sRetValue);
$bAdd = AddOrUpdateOneKey($i_sSection, $i_sKey, $i_sNewValue);
**************************************
*/
class VitFileINI
//***************
{
// for PHP4 replace public with var
 public $m_sFileINI = "";
 public $m_sSection = "";
 public $m_nLines = 0;
 public $m_nRecords = 0; // actual Records of INI file
 public $m_a2rDataINI = array(); // [$sSection][$sKey] = $sValue
 // [$sSection][$sLineNum] = $sComment
 public $m_asKeyVal = array(); // [$sKey] = $sValue (view only)

//============================================

function VitFileINI()
{
}
//========================================

function SetFileINI($i_sFileINI)
//------------------------------
{
 $this->m_sFileINI = trim($i_sFileINI);
 if (! File_Exists($i_sFileINI)) return false;
 if (FileSize($i_sFileINI) < 3) return false; // key: [k]
 return true;
}
//=========================================

// WARNING: It may create new INI file with default params
function SetOrCreateFileINI($i_sFileINI)
//------------------------------
{
  $this->m_sFileINI = trim($i_sFileINI);
  if (! File_Exists($i_sFileINI))
  {
    $fWR = fopen($i_sFileINI, "w");
    if (! $fWR)
    {
      print "ERROR: Cannot set or create INI file: $i_sFileINI \n";
      return false;
    }
    fwrite($fWR, "");
    fclose($fWR);
    @chmod($i_sFileINI, 0666);
  }

return true;
}
//========================================

function SetCurrentSection($i_sSection)  // without '[]'
{
  $this->m_sSection = trim($i_sSection);
}
//========================================

function ReadParseFileINI()
//------------------------
{
  $fRD = fopen($this->m_sFileINI, "r");
  if (! $fRD)
  {
    print "ERROR: Cannot open File INI: $this->m_sFileINI \n";
    return false;
  }

$this->m_a2rDataINI = array();  // clean array
  $this->m_asKeyVal = array();

$a2rData = &$this->m_a2rDataINI;
  $sSection = "";
  $niLine = 0;
  $niRec = 0;
  $bEmpty = false;

while (! feof($fRD))
  {
    $niLine++;
    $sLineINI = trim(fgets($fRD, 1024));
    if (substr($sLineINI, 0, 2) == '//')
    {
      $a2rData[$sSection][$niLine] = $sLineINI;
      continue;  // C++ Comment
    }

if (substr($sLineINI, 0, 1) == ';') // INI-Comment
    {
      $a2rData[$sSection][$niLine] = $sLineINI;
      continue;
    }

if (strlen($sLineINI) < 3)
 {
 if (! $bEmpty)
 $a2rData[$sSection][$niLine] = ""; // $sLineINI;
 $bEmpty = true;
 continue; // Empty or Short Line: A=B etc. > 3 chars
 }
 $bEmpty = false;

if (substr($sLineINI, 0, 1) == "[") // INI-Section
 {
 $niInit = 0; // strpos($sLineINI, "[");
 $niEnd = strpos($sLineINI, "]");
 if ($niEnd < 2) continue;
 $sSection = substr($sLineINI, 1, $niEnd-1); // exclude []
 if (! IsSet($a2rData[$sSection]))
 $a2rData[$sSection] = array(); // new section
 continue;
 }

$arLine = explode("=", $sLineINI);
 if (count($arLine) < 2)
 {
 $a2rData[$sSection][$niLine] = ""; // $sLineINI;
 continue;
 }

$sKey   = trim($arLine[0]);
    $sValue = trim($arLine[1]);
    $a2rData[$sSection][$sKey] = $sValue;  // may be last value
    $this->m_asKeyVal[$sKey] = $sValue;  // may be format "NNN.kkk [unit]"
    $niRec++;
  }

fclose($fRD);
  $this->m_nLines = $niLine;
  $this->m_nRecords = $niRec; // without sections
  return true;
}
//============================================

function GetNumOfLinesINI()
{
  return $this->m_nLines;
}
//===========================================

function IsKeyINI($i_sKey)
{
  if (! IsSet($this->m_a2rDataINI[$this->m_sSection]) ) return false;
  $sKey = trim($i_sKey);
  if (! IsSet($this->m_a2rDataINI[$this->m_sSection][$sKey] )) return false;
  return true;
}
//============================================

function GetValueINI($i_sKey, $i_sDefault="")
//-------------------------------------------
{
  if (! IsSet($this->m_a2rDataINI[$this->m_sSection]) ) return $i_sDefault;
  $sKey = trim($i_sKey);
  if (! IsSet($this->m_a2rDataINI[$this->m_sSection][$sKey] )) return $i_sDefault;
  $sValue = $this->m_a2rDataINI[$this->m_sSection][$sKey];
  return $sValue;
}
//============================================

function AddSectionINI($i_sSection)  // witout []
{
  $sSection = trim($i_sSection);
  if (IsSet($this->m_a2rDataINI[$sSection]) ) return false;
  $this->m_a2rDataINI[$sSection] = array();
  return true;
}
//==============================================

function SetValueINI($i_sKey, $i_sValue)
{
  $this->AddSectionINI($this->m_sSection);
  $sKey = trim($i_sKey);
  $this->m_a2rDataINI[$this->m_sSection][$sKey] = trim($i_sValue);
}
//=================================================

function WriteAllFileINI()
//---------------------
{
 $nSects = count($this->m_a2rDataINI);
 if ($nSects < 1 || $this->m_nLines < 1)
 {
 print " *** No one Sections or lines to save in INI file:
 $this->m_sFileINI \n";
 return false;
 }

$fWR = fopen($this->m_sFileINI, "w");
  if (! $fWR)
  {
    print "ERROR: Cannot write to File INI: $this->m_sFileINI \n";
    return false;
  }
  $a2rData = &$this->m_a2rDataINI;

foreach ($a2rData as $sSectKey=>$asSectName)
  {
    if (strlen($sSectKey) > 0)
      fputs($fWR, "[$sSectKey]\r\n");

foreach ($asSectName as $sKey=>$sValue)
    {
      $bIs = is_int($sKey);
      if (! $bIs)
        fputs($fWR, "$sKey=$sValue\r\n");
      else
        fputs($fWR, "$sValue\r\n");
    }
    fputs($fWR, "\r\n");
  }  // foreach

fclose($fWR);
  return true;
}
//====================================================

// $i_sSection = false - any section
function ReadOneKey($i_sSection, $i_sKey, &$o_sValue)
//----------------------------------------------------
{
 $fRD = fopen($this->m_sFileINI, "r");
 if (! $fRD)
 {
 print " ERROR: Cannot open File INI: $this->m_sFileINI \n";
 return -1;
 }

$sSection = "";
  $niLine = -1;
  $bSectInit = false;
  $bFound = false;
  $sValue = false;

while (! feof($fRD))
 {
 $niLine++;
 $sLineINI = trim(fgets($fRD, 1024));
 if (substr($sLineINI, 0, 2) == '//') continue; // C++ Comment
 if (substr($sLineINI, 0, 1) == ';') continue; // INI-Comment
 if (strlen($sLineINI) < 3) continue; // Empty or Short Line < 3 chars: A=B >= 3 chars

if (substr($sLineINI, 0, 1) == "[") // Init.Section
 {
 $niInit = 0; // strpos($sLineINI, "[");
 $niEnd = strpos($sLineINI, "]");
 if ($niEnd < 2) continue;
 $sSection = substr($sLineINI, 1, $niEnd-1); // exclude []
 if (strcasecmp($sSection, $i_sSection) == 0)
 $bSectInit = true; // start section (may be some times)
 else
 $bSectInit = false; // stop section
 continue;
 }
 if (! $bSectInit && $i_sSection) continue;

$arLine = explode("=", $sLineINI);
 if (count($arLine) < 2) continue; // it is not INI line: Key=Value

$sKey   = trim($arLine[0]);
    if (strcasecmp($sKey, $i_sKey) != 0) continue;

$sValue = trim($arLine[1]);
    $bFound = true;
    break;
  } // while

fclose($fRD);
  if ($bFound) $o_sValue = $sValue;
  return $niLine;
}
//============================================

function AddOrUpdateOneKey($i_sSection, $i_sKey, $i_sNewValue)
//----------------------------------------------------
{
  $fRD = fopen($this->m_sFileINI, "r");
  if (! $fRD)
  {
    print "ERROR: Cannot open File INI: $this->m_sFileINI \n";
    return false;
  }

$sSection = "";
  $niLine = -1;
  $bSectInit = false;
  $sValue = false;
  $sKeyFind = trim($i_sKey);
  $sNewVal = trim($i_sNewValue);
  $asLines = array();
  $niFound = -1;

while (! feof($fRD))
 {
 $niLine++;
 $sLineKey = fgets($fRD, 1024);
 $sLineINI = trim($sLineKey);
 $asLines[$niLine] = $sLineINI;
 if ($niFound >= 0) continue;
 if (substr($sLineINI, 0, 2) == '//') continue; // C++ Comment
 if (substr($sLineINI, 0, 1) == ';') continue; // INI-Comment
 if (strlen($sLineINI) < 3) continue; // Empty or Short Line < 3 chars: A=B >= 3 chars

$arLine = explode("=", $sLineINI);
 if (count($arLine) < 2) continue; // it is not INI line, must be: Key=Value

$sKey   = trim($arLine[0]);
    if (strcasecmp($sKey, $sKeyFind) != 0) continue;

$sValue = trim($arLine[1]);
    $niFound = $niLine;
  } // while

fclose($fRD);
  $fWR = fopen($this->m_sFileINI, "w");
  if (! $fWR)
  {
    print "ERROR: Cannot Update File INI: $this->m_sFileINI \n";
    return false;
  }

$nLines = count($asLines);
 $bUpdate = false;
 // copy all lines and update one line key=value
 for ($ni=0; $ni<$nLines; $ni++)
 {
 $sLine = $asLines[$ni];
 if ($ni != $niFound)
 {
 fputs($fWR, "$sLine\r\n");
 continue;
 }
 fputs($fWR, "$sKeyFind=$sNewVal\r\n"); // update key
 $bUpdate = true;
 }

if ($bUpdate)
  {
    fclose($fWR);
    return true;
  }

if ($i_sSection && ! $bSectInit) // section not found or was ended
  {
    fputs($fWR, "[$i_sSection]\r\n");  // add new or expand ended section
  }
  fputs ($fWR, "$sKeyFind=$sNewVal\r\n");  // add new key
  fclose($fWR);
  return true;
}
//============================================

} //**** END VitFileINI.php  class

Home Page	Art-Shop	Colors Rev.	Art-Gallery
Articles	FAQ	MAP	Miscellanea