creole.util
[ class tree: creole.util ] [ index: creole.util ] [ all elements ]

Class: Clob

Source Location: /creole/util/Clob.php

Class Overview

Lob
   |
   --Clob

A class for handling character (ASCII) LOBs.


Author(s):

Version:

  • $Revision: 1.6 $

Methods


Inherited Variables

Inherited Methods

Class: Lob

Lob::__construct()
Construct a new Lob.
Lob::dump()
Dump the contents of the file to stdout.
Lob::getContents()
Get the contents of the LOB.
Lob::getInputFile()
Get the file that we want this LOB read from.
Lob::getOutputFile()
Get the file that we want this LOB saved to.
Lob::isFromFile()
Returns whether this Lob is loaded from file.
Lob::isModified()
Whether LOB contents have been modified after initial setting.
Lob::readFromFile()
Read LOB data from file (binary safe).
Lob::setContents()
Set the contents of this LOB.
Lob::setInputFile()
Specify the file that we want this LOB read from.
Lob::setModified()
Set whether LOB contents have been modified after initial setting.
Lob::setOutputFile()
Specify the file that we want this LOB saved to.
Lob::writeToFile()
Write LOB data to file (binary safe).
Lob::__toString()
Convenience method to get contents of LOB as string.

Class Details

[line 31]
A class for handling character (ASCII) LOBs.



Tags:

version:  $Revision: 1.6 $
author:  Hans Lellelid <hans@xmpl.org>


[ Top ]


Class Methods


method dump [line 88]

void dump( )

Dump the contents of the file using fpassthru().



Tags:

throws:  Exception if no file or contents.


Overrides Lob::dump() (Dump the contents of the file to stdout.)

[ Top ]

method readFromFile [line 40]

void readFromFile( [string $file = null])

Read LOB data from file.



Tags:

access:  public
see:  Lob::setInputFile()
throws:  Exception - if no file specified or error on read.


Overrides Lob::readFromFile() (Read LOB data from file (binary safe).)

Parameters:

string   $file   Filename may also be specified here (if not specified using setInputFile()).

[ Top ]

method writeToFile [line 65]

void writeToFile( [string $file = null])

Write LOB data to file.



Tags:

access:  public
see:  Lob::setOutputFile()
throws:  Exception - if no file specified, no contents to write, or error on write.


Overrides Lob::writeToFile() (Write LOB data to file (binary safe).)

Parameters:

string   $file   Filename may also be specified here (if not set using setOutputFile()).

[ Top ]


Documentation generated on Mon, 23 Aug 2004 21:51:14 -0400 by phpDocumentor 1.3.0RC3