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

Class: File_Therion_DirectWriter

Source Location: /File_Therion-0.4.1/File/Therion/Writers/DirectWriter.php

Class Overview


The writer just dumps the line content into the configured filepath.


Author(s):

Copyright:

  • 2016 Benedikt Hallinger

Variables

Methods


Child classes:

File_Therion_StructuredWriter
The writer creates nested file structures linked with 'input' commands.

Inherited Variables

Inherited Methods


Class Details

[line 30]
The writer just dumps the line content into the configured filepath.

This essentially will create one therion file that equals this file: Surveys, Scraps etc will be nested structures in this one big file.

The target file will be overwritten.



[ Top ]


Class Variables

$createDirs =  true

[line 44]

Create nonexisting directorys?
  • Access: protected

Type:   boolean


[ Top ]

$overwrite =  true

[line 37]

Overwrite existing files?
  • Access: protected

Type:   boolean


[ Top ]



Method Detail

switchCreateDirs   [line 131]

void switchCreateDirs( boolean $yesno)

Switch automatic creation of intermediate directorys.
  • Access: public

Parameters:

boolean   $yesno   — 

[ Top ]

switchOverwrite   [line 121]

void switchOverwrite( boolean $yesno)

Switch overwriting permission.
  • Access: public

Parameters:

boolean   $yesno   — 

[ Top ]

write   [line 57]

void write( File_Therion $file)

Write a Therion file structure.

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

  • Todo: implement wrapping
  • Throws: File_Therion_IOException in case of IO error
  • Throws: File_Therion_Exception for other errors
  • Access: public

Overridden in child classes as:

File_Therion_StructuredWriter::write()
Write a Therion file structure.

Parameters:

File_Therion   $file   —  the file object to write

[ Top ]


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