File_Therion_Readers
[ class tree: File_Therion_Readers ] [ index: File_Therion_Readers ] [ all elements ]

Class: File_Therion_FileReader

Source Location: /File_Therion-0.4.1/File/Therion/Readers/FileReader.php

Class Overview


Reader class that reads disk files (filepaths)


Author(s):

Copyright:

  • 2016 Benedikt Hallinger

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 25]
Reader class that reads disk files (filepaths)


[ Top ]


Class Variables

$clear =  true

[line 33]

Should the file object be resetted before fetching?
  • Access: protected

Type:   boolean


[ Top ]



Method Detail

fetch   [line 47]

void fetch( File_Therion $file)

Read local file and add lines to Therion file object.

This will be called by File_Therion->fetch() to actually perform the read.

  • Throws: File_Therion_IOException in case of IO error
  • Throws: File_Therion_SyntaxException in case of parsing-to-file-obj error
  • Throws: File_Therion_Exception for other errors
  • Access: public

Parameters:

File_Therion   $file   —  the file object to generate lines into

[ Top ]

switchClearing   [line 98]

void switchClearing( [boolean $setting = false])

Switches cleaning of file objects lines when fetching.
  • Access: public

Parameters:

boolean   $setting   —  true=clear, false=leave lines alone

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:09:45 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.