Search/Lucene/Storage/File/Memory.php

Show: PublicProtectedPrivateinherited
Table of Contents
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

>VPropertyprivatestring $_data
FileData
Details
Type
string
>VPropertyprivateinteger $_position = 0
File Position
Default value0Details
Type
integer

Methods

methodpublic__construct(string $data) : void

Object constractor

Parameters
NameTypeDescription
$datastring
methodprotected_fread(integer $length = 1) : string

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

Parameters
NameTypeDescription
$lengthinteger
Returns
TypeDescription
string
methodprotected_fwrite(string $data, integer $length = null) : void

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

Parameters
NameTypeDescription
$datastring
$lengthinteger
methodpublicflush() : boolean

Flush output.

Returns true on success or false on failure.
Returns
TypeDescription
boolean
methodpubliclock(integer $lockType,  $nonBlockinLock = false) : boolean

Lock file

Lock type may be a LOCK_SH (shared lock) or a LOCK_EX (exclusive lock)
Parameters
NameTypeDescription
$lockTypeinteger
$nonBlockinLock
Returns
TypeDescription
boolean
methodpublicreadBinary() : string

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

Returns
TypeDescription
string
methodpublicreadByte() : integer

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

Returns
TypeDescription
integer
methodpublicreadBytes(integer $num) : string

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

Parameters
NameTypeDescription
$numinteger
Returns
TypeDescription
string
methodpublicreadInt() : integer

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

Returns
TypeDescription
integer
methodpublicreadLong() : integer

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

Returns
TypeDescription
integer
Throws
ExceptionDescription
\Zend_Search_Lucene_Exception
methodpublicreadLong32Bit() : 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).

Returns
TypeDescription
integer | float
Throws
ExceptionDescription
\Zend_Search_Lucene_Exception
methodpublicreadString() : string

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

Returns
TypeDescription
string
methodpublicreadVInt() : integer

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

Returns
TypeDescription
integer
methodpublicseek(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
Parameters
NameTypeDescription
$offsetinteger
$whenceinteger
Returns
TypeDescription
integer
methodpublictell() : integer

Get file position.

Returns
TypeDescription
integer
methodpublicunlock() : void

Unlock file

methodpublicwriteByte(integer $byte) : void

Writes a byte to the end of the file.

Parameters
NameTypeDescription
$byteinteger
methodpublicwriteBytes(string $data, integer $num = null) : void

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

Parameters
NameTypeDescription
$datastring
$numinteger
methodpublicwriteInt(integer $value) : void

Writes an integer to the end of file.

Parameters
NameTypeDescription
$valueinteger
methodpublicwriteLong(integer $value) : void

Writes long integer to the end of file

Parameters
NameTypeDescription
$valueinteger
Throws
ExceptionDescription
\Zend_Search_Lucene_Exception
methodpublicwriteLong32Bit(integer | float $value) : void

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

Parameters
NameTypeDescription
$valueinteger | float
Throws
ExceptionDescription
\Zend_Search_Lucene_Exception
methodpublicwriteString(string $str) : void

Writes a string to the end of file.

Parameters
NameTypeDescription
$strstring
Throws
ExceptionDescription
\Zend_Search_Lucene_Exception
methodpublicwriteVInt(integer $value) : void

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

Parameters
NameTypeDescription
$valueinteger
Documentation was generated by phpDocumentor 2.2.0 .