Sitellite Application Framework
Class Tree         Index         All Elements

Procedural File: Ini.php

Source Location: Program_Root/Misc/Ini.php



Classes:

Ini
Class for parsing, transforming, and writing files in the INI format, as defined by the PHP parse_ini_file() function.


Page Details:









ini_add_filter [line 315]

void ini_add_filter( string $func, [array $keys = array ()])

Adds a filter to the global $ini object. Alias of addFilter() method.



Parameters

string   $func  
array   $keys  
[ Top ]



ini_clear [line 335]

void ini_clear( )

Clears the list of filters in the global $ini object.

Alias of clear() method.




[ Top ]



ini_filter [line 327]

array ini_filter( array $data, [boolean $sections = true])

Filters the specified data using the global $ini object.

Alias of filter() method.




Tags:

return:  hash


Parameters

array   $data   hash
boolean   $sections  
[ Top ]



ini_filter_replace_backticks [line 366]

string ini_filter_replace_backticks( string $value, [boolean $reverse = false])

Backtick INI filter. Replaces backticks (`) with double-quotes (").

Please note that this filter is on by default in the Ini class.

The $reverse parameters tells the filter to do the reverse of its ordinary function and return that instead. This is used by the write() method to write back an INI file correctly that has been filtered.




Parameters

string   $value  
boolean   $reverse  
[ Top ]



ini_filter_split_commas [line 387]

array ini_filter_split_commas( string $value, [boolean $reverse = false])

Comma-splitting INI filter. Breaks a string into a list by the commas in it. Note: An optional single space is allowed following commas, and will be trimmed.

The $reverse parameters tells the filter to do the reverse of its ordinary function and return that instead. This is used by the write() method to write back an INI file correctly that has been filtered.




Parameters

string   $value  
boolean   $reverse  
[ Top ]



ini_filter_split_comma_single [line 411]

array ini_filter_split_comma_single( string $value, [boolean $reverse = false])

Single-comma-splitting INI filter. Breaks a string into two by the first comma in it. Note: An optional single space is allowed following the comma, and will be trimmed.

The $reverse parameters tells the filter to do the reverse of its ordinary function and return that instead. This is used by the write() method to write back an INI file correctly that has been filtered.




Parameters

string   $value  
boolean   $reverse  
[ Top ]



ini_parse [line 305]

array ini_parse( string $file, [boolean $sections = true])

Parses an INI file -- calls parse() on a global $ini object.



Tags:

return:  hash


Parameters

string   $file  
boolean   $sections  
[ Top ]



ini_write [line 347]

string ini_write( array $struct, [string $instructions = false])

Writes an INI data string from the specified structure.

Alias of write() in global $ini object.




Parameters

array   $struct   hash
string   $instructions  
[ Top ]



Copyright © 2007, SIMIAN systems Inc.
All rights reserved. Privacy policy
Documentation generated on Tue, 13 Feb 2007 17:17:49 -0600 by Sitellite AppDoc and phpDocumentor 1.2.2