Class Zend_Search_Lucene_Storage_File_Memory

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

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

Zend_Search_Lucene_Storage_File
   |
   --Zend_Search_Lucene_Storage_File_Memory
Method Summary
 Zend_Search_Lucene_Storage_File_Memory __construct (string $data)
 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
Constructor __construct (line 59)

Object constractor

  • access: public
Zend_Search_Lucene_Storage_File_Memory __construct (string $data)
  • string $data
flush (line 133)

Flush output.

Returns true on success or false on failure.

  • access: public
boolean flush ()

Redefinition of:
Zend_Search_Lucene_Storage_File::flush()
Flush output.
lock (line 169)

Lock file

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

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

Redefinition of:
Zend_Search_Lucene_Storage_File::lock()
Lock file
readBinary (line 547)

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

  • access: public
string readBinary ()

Redefinition of:
Zend_Search_Lucene_Storage_File::readBinary()
Reads binary data from the current position in the file and advances the file pointer.
readByte (line 192)

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

  • access: public
integer readByte ()

Redefinition of:
Zend_Search_Lucene_Storage_File::readByte()
Reads a byte from the current position in the file and advances the file pointer.
readBytes (line 220)

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

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

Redefinition of:
Zend_Search_Lucene_Storage_File::readBytes()
Read num bytes from the current position in the file and advances the file pointer.
readInt (line 256)

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

  • access: public
integer readInt ()

Redefinition of:
Zend_Search_Lucene_Storage_File::readInt()
Reads an integer from the current position in the file and advances the file pointer.
readLong (line 295)

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

Redefinition of:
Zend_Search_Lucene_Storage_File::readLong()
Returns a long integer from the current position in the file and advances the file pointer.
readString (line 416)

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

  • access: public
string readString ()

Redefinition of:
Zend_Search_Lucene_Storage_File::readString()
Reads a string from the current position in the file and advances the file pointer.
readVInt (line 377)

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

  • access: public
integer readVInt ()

Redefinition of:
Zend_Search_Lucene_Storage_File::readVInt()
Returns a variable-length integer from the current position in the file and advances the file pointer.
seek (line 95)

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
integer seek (integer $offset, [integer $whence = SEEK_SET])
  • integer $offset
  • integer $whence

Redefinition of:
Zend_Search_Lucene_Storage_File::seek()
Sets the file position indicator and advances the file pointer.
tell (line 121)

Get file position.

  • access: public
integer tell ()

Redefinition of:
Zend_Search_Lucene_Storage_File::tell()
Get file position.
unlock (line 180)

Unlock file

  • access: public
void unlock ()

Redefinition of:
Zend_Search_Lucene_Storage_File::unlock()
Unlock file
writeByte (line 202)

Writes a byte to the end of the file.

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

Redefinition of:
Zend_Search_Lucene_Storage_File::writeByte()
Writes a byte to the end of the file.
writeBytes (line 235)

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

Redefinition of:
Zend_Search_Lucene_Storage_File::writeBytes()
Writes num bytes of data (all, if $num===null) to the end of the string.
writeInt (line 273)

Writes an integer to the end of file.

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

Redefinition of:
Zend_Search_Lucene_Storage_File::writeInt()
Writes an integer to the end of file.
writeLong (line 335)

Writes long integer to the end of file

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

Redefinition of:
Zend_Search_Lucene_Storage_File::writeLong()
Writes long integer to the end of file
writeString (line 475)

Writes a string to the end of file.

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

Redefinition of:
Zend_Search_Lucene_Storage_File::writeString()
Writes a string to the end of file.
writeVInt (line 394)

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

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

Redefinition of:
Zend_Search_Lucene_Storage_File::writeVInt()
Writes a variable-length integer to the end of file.
_fread (line 71)

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

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

Redefinition of:
Zend_Search_Lucene_Storage_File::_fread()
Reads $length number of bytes at the current position in the file and advances the file pointer.
_fwrite (line 147)

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

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

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

Inherited Methods

Inherited From Zend_Search_Lucene_Storage_File

 Zend_Search_Lucene_Storage_File::flush()
 Zend_Search_Lucene_Storage_File::lock()
 Zend_Search_Lucene_Storage_File::readBinary()
 Zend_Search_Lucene_Storage_File::readByte()
 Zend_Search_Lucene_Storage_File::readBytes()
 Zend_Search_Lucene_Storage_File::readInt()
 Zend_Search_Lucene_Storage_File::readLong()
 Zend_Search_Lucene_Storage_File::readString()
 Zend_Search_Lucene_Storage_File::readVInt()
 Zend_Search_Lucene_Storage_File::seek()
 Zend_Search_Lucene_Storage_File::tell()
 Zend_Search_Lucene_Storage_File::unlock()
 Zend_Search_Lucene_Storage_File::writeByte()
 Zend_Search_Lucene_Storage_File::writeBytes()
 Zend_Search_Lucene_Storage_File::writeInt()
 Zend_Search_Lucene_Storage_File::writeLong()
 Zend_Search_Lucene_Storage_File::writeString()
 Zend_Search_Lucene_Storage_File::writeVInt()
 Zend_Search_Lucene_Storage_File::_fread()
 Zend_Search_Lucene_Storage_File::_fwrite()

Documentation generated on Wed, 21 Feb 2007 11:54:03 -0800 by phpDocumentor 1.3.1