| category |
Zend |
| package |
Zend_Search_Lucene |
| subpackage |
Storage |
| copyright |
Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
| license |
New BSD License |
Methods
Flush output.
flush() : boolean
Returns true on success or false on failure.
Returns
boolean
Lock file
lock(integer $lockType, $nonBlockinLock = false) : boolean
Lock type may be a LOCK_SH (shared lock) or a LOCK_EX (exclusive lock)
Parameters
$lockType
integer
$nonBlockinLock
Returns
boolean
Reads binary data from the current position in the file
and advances the file pointer.
readBinary() : string
Reads a byte from the current position in the file
and advances the file pointer.
readByte() : integer
Read num bytes from the current position in the file
and advances the file pointer.
readBytes(integer $num) : string
Parameters
$num
integer
Returns
string
Reads an integer from the current position in the file
and advances the file pointer.
readInt() : integer
Returns a long integer from the current position in the file
and advances the file pointer.
readLong() : integer | float
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
integerfloat
Returns a long integer from the current position in the file,
advances the file pointer and return it as float (for 32-bit platforms).
readLong32Bit() : integer | float
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
integerfloat
Reads a string from the current position in the file
and advances the file pointer.
readString() : string
Returns a variable-length integer from the current
position in the file and advances the file pointer.
readVInt() : integer
Sets the file position indicator and advances the file pointer.
seek(integer $offset, integer $whence = SEEK_SET) : integer
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
Parameters
$offset
integer
$whence
integer
Returns
integer
Get file position.
tell() : integer
Writes a byte to the end of the file.
writeByte(integer $byte)
Writes num bytes of data (all, if $num===null) to the end
of the string.
writeBytes(string $data, integer $num = null)
Parameters
$data
string
$num
integer
Writes an integer to the end of file.
writeInt(integer $value)
Parameters
$value
integer
Writes long integer to the end of file
writeLong(integer $value)
Parameters
$value
integer
Exceptions
\Zend_Search_Lucene_Exception |
|
Writes long integer to the end of file (32-bit platforms implementation)
writeLong32Bit(integer|float $value)
Parameters
$value
integerfloat
Exceptions
\Zend_Search_Lucene_Exception |
|
Writes a string to the end of file.
writeString(string $str)
Parameters
$str
string
Exceptions
\Zend_Search_Lucene_Exception |
|
Writes a variable-length integer to the end of file.
writeVInt(integer $value)
Parameters
$value
integer
Reads $length number of bytes at the current position in the
file and advances the file pointer.
_fread(integer $length = 1) : string
Parameters
$length
integer
Returns
string
Writes $length number of bytes (all, if $length===null) to the end
of the file.
_fwrite(string $data, integer $length = null)
Parameters
$data
string
$length
integer