DomCI : Update all the PHPDoc

git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@3279 bf3deb0d-5f1a-0410-827f-c0cc1f45334c
This commit is contained in:
2016-12-09 14:47:48 +00:00
parent b102168208
commit b55ea95fae
21 changed files with 953 additions and 424 deletions

View File

@@ -8,8 +8,12 @@
class inifile
{
/** Return an array with the .ini file content
If the sections are true, the sections are analyzed too
This function is the same as parse_ini_file PHP internal */
* If the sections are true, the sections are analyzed too
* This function is the same as parse_ini_file PHP internal
* @param string $file The ini file to read
* @param boolean|null $sections Manage the sections if true. False by
* default
*/
public function getFile ($file, $sections=false)
{
if (! file_exists ($file))
@@ -22,8 +26,12 @@ class inifile
}
/** Return an array with the .ini string content
If the sections are true, the sections are analyzed too
This function is the same as parse_ini_string PHP internal */
* If the sections are true, the sections are analyzed too
* This function is the same as parse_ini_string PHP internal
* @param string $string The ini string to read
* @param boolean|null $sections Manage the sections if true. False by
* default
*/
public function getString ($string, $sections=false)
{
$res = parse_ini_string ($string, $sections);
@@ -58,7 +66,10 @@ class inifile
}
/** Return a string containing a .ini content from the provided array.
If the sections are true, define the first child of the array as sections
* If the sections are true, define the first child of the array as sections
* @param array $array The array read from a .ini file
* @param boolean|null $sections Manage the sections if true. False by
* default
*/
public function setString ($array, $sections=false)
{
@@ -132,8 +143,12 @@ class inifile
}
/** Save a file containing a .ini content from the provided array.
Don't create the directory if it doesn't exists
If the sections are true, define the first child of the array as sections
* Don't create the directory if it doesn't exists
* If the sections are true, define the first child of the array as sections
* @param string $file The .ini file to store
* @param array $array The array to store in file
* @param boolean|null $sections Manage the sections if true. False by
* default
*/
public function setFile ($file, $array, $sections=false)
{