Abstract Class Zend_Search_Lucene_Storage_File

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

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


	
			
Direct descendents
Method Summary
 boolean flush ()
 boolean lock (integer $lockType, [ $nonBlockinLock = false])
 string readBinary ()
 integer readByte ()
 string readBytes (integer $num)
 integer readInt ()
 integer|float readLong ()
 integer|float readLong32Bit ()
 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 writeLong32Bit (integer|float $value)
 void writeString (string $str)
 void writeVInt (integer $value)
 string _fread ([integer $length = 1])
 void _fwrite (string $data, [integer $length = null])
Methods
flush (line 74)

Flush output.

Returns true on success or false on failure.

  • abstract:
  • access: public
boolean flush ()

Redefined in descendants as:
lock (line 93)

Lock file

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

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

Redefined in descendants as:
readBinary (line 469)

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

  • access: public
string readBinary ()

Redefined in descendants as:
readByte (line 106)

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

  • access: public
integer readByte ()

Redefined in descendants as:
readBytes (line 128)

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

  • access: public
string readBytes (integer $num)
  • integer $num

Redefined in descendants as:
readInt (line 152)

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

  • access: public
integer readInt ()

Redefined in descendants as:
readLong (line 185)

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

  • throws: Zend_Search_Lucene_Exception
  • access: public
integer|float readLong ()

Redefined in descendants as:
readLong32Bit (line 242)

Returns a long integer from the current position in the file, advances the file pointer and return it as float (for 32-bit platforms).

  • throws: Zend_Search_Lucene_Exception
  • access: public
integer|float readLong32Bit ()

Redefined in descendants as:
readString (line 345)

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

  • access: public
string readString ()

Redefined in descendants as:
readVInt (line 311)

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

  • access: public
integer readVInt ()

Redefined in descendants as:
seek (line 58)

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

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

Redefined in descendants as:
tell (line 65)

Get file position.

  • abstract:
  • access: public
integer tell ()

Redefined in descendants as:
unlock (line 98)

Unlock file

  • abstract:
  • access: public
void unlock ()

Redefined in descendants as:
writeByte (line 116)

Writes a byte to the end of the file.

  • access: public
void writeByte (integer $byte)
  • integer $byte

Redefined in descendants as:
writeBytes (line 140)

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

Redefined in descendants as:
writeInt (line 168)

Writes an integer to the end of file.

  • access: public
void writeInt (integer $value)
  • integer $value

Redefined in descendants as:
writeLong (line 213)

Writes long integer to the end of file

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

Redefined in descendants as:
writeLong32Bit (line 279)

Writes long integer to the end of file (32-bit platforms implementation)

  • throws: Zend_Search_Lucene_Exception
  • access: public
void writeLong32Bit (integer|float $value)
  • integer|float $value

Redefined in descendants as:
writeString (line 402)

Writes a string to the end of file.

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

Redefined in descendants as:
writeVInt (line 328)

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

  • access: public
void writeVInt (integer $value)
  • integer $value

Redefined in descendants as:
_fread (line 39)

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

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

Redefined in descendants as:
_fwrite (line 83)

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

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

Redefined in descendants as:

Documentation generated on Mon, 21 Jun 2010 15:23:25 -0400 by phpDocumentor 1.4.3