Abstract Class ZSearchFile

Description

Located in /incubator/Zend/Search/Lucene/storage/ZSearchFile.php (line 28)


	
			
Direct descendents
Class Description
 class ZSearchFileFilesystem
Method Summary
 ZSearchFile __construct (mixed $filename, [mixed $mode = 'r'])
 void __destruct ()
 string readBinary ()
 integer readByte ()
 string readBytes (integer $num)
 integer readInt ()
 integer readLong ()
 string readString ()
 integer readVInt ()
 integer seek (integer $offset, [integer $whence = SEEK_SET])
 integer tell ()
 void writeByte (integer $byte)
 void writeBytes (string $data, [integer $num = null])
 void writeInt (integer $value)
 void writeLong (integer $value)
 void writeString (string $str)
 void writeVInt (integer $value)
 string _fread ([integer $length = 1])
 void _fwrite (string $data, [integer $length = null])
Methods
Constructor __construct (line 34)

Class constructor. Open the file.

  • access: public
  • abstract:
ZSearchFile __construct (mixed $filename, [mixed $mode = 'r'])

Redefined in descendants as:
Destructor __destruct (line 40)

Class destructor. Close the file.

  • access: public
  • abstract:
void __destruct ()

Redefined in descendants as:
readBinary (line 375)

Reads binary data from the current position in the file and advances the file pointer.

  • access: public
string readBinary ()
readByte (line 94)

Reads a byte from the current position in the file and advances the file pointer.

  • access: public
integer readByte ()
readBytes (line 116)

Read num bytes from the current position in the file and advances the file pointer.

  • access: public
string readBytes (integer $num)
  • integer $num
readInt (line 140)

Reads an integer from the current position in the file and advances the file pointer.

  • access: public
integer readInt ()
readLong (line 172)

Returns a long integer from the current position in the file and advances the file pointer.

  • access: public
integer readLong ()
readString (line 255)

Reads a string from the current position in the file and advances the file pointer.

  • access: public
string readString ()
readVInt (line 221)

Returns a variable-length integer from the current position in the file and advances the file pointer.

  • access: public
integer readVInt ()
seek (line 69)

Sets the file position indicator and advances the file pointer.

The new position, measured in bytes from the beginning of the file, is obtained by adding offset to the position specified by whence, whose values are defined as follows: SEEK_SET - Set position equal to offset bytes. SEEK_CUR - Set position to current location plus offset. SEEK_END - Set position to end-of-file plus offset. (To move to a position before the end-of-file, you need to pass a negative value in offset.) Upon success, returns 0; otherwise, returns -1

  • access: public
  • abstract:
integer seek (integer $offset, [integer $whence = SEEK_SET])
  • integer $offset
  • integer $whence

Redefined in descendants as:
tell (line 76)

Get file position.

  • access: public
  • abstract:
integer tell ()

Redefined in descendants as:
writeByte (line 104)

Writes a byte to the end of the file.

  • access: public
void writeByte (integer $byte)
  • integer $byte
writeBytes (line 128)

Writes num bytes of data (all, if $num===null) to the end of the file.

  • access: public
void writeBytes (string $data, [integer $num = null])
  • string $data
  • integer $num
writeInt (line 156)

Writes an integer to the end of file.

  • access: public
void writeInt (integer $value)
  • integer $value
writeLong (line 197)

Writes long integer to the end of file

  • access: public
void writeLong (integer $value)
  • integer $value
writeString (line 312)

Writes a string to the end of file.

  • access: public
  • throws: Zend_Search_Lucene_Exception
void writeString (string $str)
  • string $str
writeVInt (line 238)

Writes a variable-length integer to the end of file.

  • access: public
void writeVInt (integer $value)
  • integer $value
_fread (line 50)

Reads $length number of bytes at the current position in the file and advances the file pointer.

  • access: protected
  • abstract:
string _fread ([integer $length = 1])
  • integer $length

Redefined in descendants as:
_fwrite (line 85)

Writes $length number of bytes (all, if $length===null) to the end of the file.

  • access: protected
  • abstract:
void _fwrite (string $data, [integer $length = null])
  • string $data
  • integer $length

Redefined in descendants as:

Documentation generated on Wed, 08 Mar 2006 04:56:40 -0800 by phpDocumentor 1.3.0RC4