filters/util/IniFileTokenReader.php

Show: inherited
Table of Contents

Class that allows reading tokens from INI files.

Author
Manuel Holtgewe  
Package
phing.filters.util  
Version
$Id$  

\IniFileTokenReader

Package: phing\filters\util

Class that allows reading tokens from INI files.

Parent(s)
\TokenReader
Author
Manuel Holtgewe  
Version
$Id$  

Properties

Propertyprivateobject  $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 valuenullDetails
Type
object
Propertyprotected\Project  $project= ''
inherited

Reference to the Project the TokenReader is used in.

Inherited from: \TokenReader::$$project
Details
Type
\Project
Inherited_from
\TokenReader::$$project  
Propertyprivatestring  $section= 'null'

Sets the section to load from the INI file. if omitted, all sections are loaded.
Default valuenullDetails
Type
string

Methods

methodpublic__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.

methodpubliclog(  $level,  $msg ) : void
inherited

Utility function for logging

Inherited from: \TokenReader::log()
Parameters
Name Type Description
$level
$msg
methodpublicreadToken( ) : \Token

Reads the next token from the INI file

Returns
Type Description
\Token
Throws
Exception Description
\IOException On error
methodpublicsetFile(  $file ) : void

Parameters
Name Type Description
$file
methodpublicsetSection(  $str ) : void

Parameters
Name Type Description
$str
Documentation was generated by DocBlox 0.18.1.