Search/Lucene/Storage/File/Memory.php
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Search_Lucene
- Subpackage
- Storage
- Version
- $Id$
\Zend_Search_Lucene_Storage_File_Memory
Package: Zend_Search_Lucene\Storage- Parent(s)
- \Zend_Search_Lucene_Storage_File
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods



_fread(integer $length = 1) : string
Reads $length number of bytes at the current position in the
file and advances the file pointer.
ParametersName | Type | Description |
---|
$length | integer | |
---|
Returns 


_fwrite(string $data, integer $length = null) : void
Writes $length number of bytes (all, if $length===null) to the end
of the file.
ParametersName | Type | Description |
---|
$data | string | |
---|
$length | integer | |
---|



readBytes(integer $num) : string
Read num bytes from the current position in the file
and advances the file pointer.
ParametersName | Type | Description |
---|
$num | integer | |
---|
Returns 


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


seek(integer $offset, integer $whence = SEEK_SET) : integer
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
ParametersName | Type | Description |
---|
$offset | integer | |
---|
$whence | integer | |
---|
Returns


writeByte(integer $byte) : void
Writes a byte to the end of the file.
ParametersName | Type | Description |
---|
$byte | integer | |
---|



writeBytes(string $data, integer $num = null) : void
Writes num bytes of data (all, if $num===null) to the end
of the string.
ParametersName | Type | Description |
---|
$data | string | |
---|
$num | integer | |
---|



writeInt(integer $value) : void
Writes an integer to the end of file.
ParametersName | Type | Description |
---|
$value | integer | |
---|



writeLong(integer $value) : void
Writes long integer to the end of file
ParametersName | Type | Description |
---|
$value | integer | |
---|
Throws 


writeLong32Bit(integer | float $value) : void
Writes long integer to the end of file (32-bit platforms implementation)
ParametersName | Type | Description |
---|
$value | integer | float | |
---|
Throws 


writeString(string $str) : void
Writes a string to the end of file.
ParametersName | Type | Description |
---|
$str | string | |
---|
Throws 


writeVInt(integer $value) : void
Writes a variable-length integer to the end of file.
ParametersName | Type | Description |
---|
$value | integer | |
---|