Abstract Class Zend_Search_Lucene_Storage_File

Description
  • abstract:
  • license: New BSD License
  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Search/Lucene/Storage/File.php (line 35)


	
			
Direct descendents
Method Summary
 boolean flush ()
 boolean lock (integer $lockType, [ $nonBlockinLock = false])
 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 unlock ()
 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
flush (line 79)

Flush output.

Returns true on success or false on failure.

  • access: public
  • abstract:
boolean flush ()

Redefined in descendants as:
lock (line 98)

Lock file

Lock type may be a LOCK_SH (shared lock) or a LOCK_EX (exclusive lock)

  • access: public
  • abstract:
boolean lock (integer $lockType, [ $nonBlockinLock = false])
  • integer $lockType
  • $nonBlockinLock

Redefined in descendants as:
readBinary (line 423)

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

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

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

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

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 157)

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

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

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

  • access: public
  • throws: Zend_Search_Lucene_Exception
integer readLong ()
readString (line 300)

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

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

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

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

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 70)

Get file position.

  • access: public
  • abstract:
integer tell ()

Redefined in descendants as:
unlock (line 103)

Unlock file

  • access: public
  • abstract:
void unlock ()

Redefined in descendants as:
writeByte (line 121)

Writes a byte to the end of the file.

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

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

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

Writes an integer to the end of file.

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

Writes long integer to the end of file

  • access: public
  • throws: Zend_Search_Lucene_Exception
void writeLong (integer $value)
  • integer $value
writeString (line 357)

Writes a string to the end of file.

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

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

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

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 88)

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 Thu, 18 Jan 2007 09:53:28 -0800 by phpDocumentor 1.3.1