# filters/util/IniFileTokenReader.php

## \IniFileTokenReader
jump to top

Package: phing\filters\util

Class that allows reading tokens from INI files.

Parent(s)
  \TokenReader
Author
  Manuel Holtgewe
Version
  $Revision: 526 $

### Properties

`object $file= 'null'`

Holds the path to the INI file that is to be read.

Reference to a PhingFile Object representing the path to the INI file.
Default value `null` Details

Type
  object

`\Project $project= ''`
inherited

Reference to the Project the TokenReader is used in.

Inherited from: \TokenReader::$project
Details

Type
  \Project
Inherited_from
  \TokenReader::$project

`string $section= 'null'`

Sets the section to load from the INI file. if omitted, all sections are loaded.
Default value `null` Details

Type
  string

### Methods

`__construct( object $project ) : void`
inherited

Constructor

Inherited from: \TokenReader::__construct()
Parameters

Name | Type | Description
--- | --- | ---
$project | object | Reference to the project the TokenReader is used in.

`log( $level, $msg ) : void`
inherited

Utility function for logging

Inherited from: \TokenReader::log()
Parameters

Name | Type | Description
--- | --- | ---
$level |  |
$msg |  |

`readToken( ) : \Token`

Reads the next token from the INI file

Returns

Type | Description
--- | ---
\Token |

Throws

Exception | Description
--- | ---
\IOException | On error

`setFile( $file ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$file |  |

`setSection( $str ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$str |  |

Documentation was generated by DocBlox 0.15.1.