Search/Lucene/Storage/File.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Search_Lucene
subpackage: Storage
version: $Id: File.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Search_Lucene_Storage_File

Description

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.

Zend_Search_Lucene_Storage_File
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Search_Lucene
subpackage: Storage
Methods: _fread; seek; tell; flush; _fwrite; lock; unlock; readByte; writeByte; readBytes; writeBytes; readInt; writeInt; readLong; writeLong; readLong32Bit; writeLong32Bit; readVInt; writeVInt; readString; writeString; readBinary

Description

Methods

_fread
jump to class

_fread(
          integer $length
              =
              1
          )
        
        :
        string

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

Arguments

$length: integer

Output

string

Details

visibility: protected
final: false
static: false

_fwrite
jump to class

_fwrite(
          string $data, integer $length
              =
              null
          )
        
        :

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

Arguments

$data: string
$length: integer

Details

visibility: protected
final: false
static: false

flush
jump to class

flush(
          
          )
        
        :
        boolean

Flush output.

Returns true on success or false on failure.

Output

boolean

Details

visibility: public
final: false
static: false

lock
jump to class

lock(
          integer $lockType,  $nonBlockinLock
              =
              false
          )
        
        :
        boolean

Lock file

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

Arguments

$lockType: integer
$nonBlockinLock

Output

boolean

Details

visibility: public
final: false
static: false

readBinary
jump to class

readBinary(
          
          )
        
        :
        string

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

Output

string

Details

visibility: public
final: false
static: false

readByte
jump to class

readByte(
          
          )
        
        :
        integer

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

Output

integer

Details

visibility: public
final: false
static: false

readBytes
jump to class

readBytes(
          integer $num
          )
        
        :
        string

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

Arguments

$num: integer

Output

string

Details

visibility: public
final: false
static: false

readInt
jump to class

readInt(
          
          )
        
        :
        integer

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

Output

integer

Details

visibility: public
final: false
static: false

readLong
jump to class

readLong(
          
          )
        
        :
        integer|float

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

Output

integer|float

Details

visibility: public
final: false
static: false
throws

readLong32Bit
jump to class

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

Output

integer|float

Details

visibility: public
final: false
static: false
throws

readString
jump to class

readString(
          
          )
        
        :
        string

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

Output

string

Details

visibility: public
final: false
static: false

readVInt
jump to class

readVInt(
          
          )
        
        :
        integer

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

Output

integer

Details

visibility: public
final: false
static: false

seek
jump to class

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

Arguments

$offset: integer
$whence: integer

Output

integer

Details

visibility: public
final: false
static: false

tell
jump to class

tell(
          
          )
        
        :
        integer

Get file position.

Output

integer

Details

visibility: public
final: false
static: false

unlock
jump to class

Unlock file

Details

visibility: public
final: false
static: false

writeByte
jump to class

writeByte(
          integer $byte
          )
        
        :

Writes a byte to the end of the file.

Arguments

$byte: integer

Details

visibility: public
final: false
static: false

writeBytes
jump to class

writeBytes(
          string $data, integer $num
              =
              null
          )
        
        :

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

Arguments

$data: string
$num: integer

Details

visibility: public
final: false
static: false

writeInt
jump to class

writeInt(
          integer $value
          )
        
        :

Writes an integer to the end of file.

Arguments

$value: integer

Details

visibility: public
final: false
static: false

writeLong
jump to class

writeLong(
          integer $value
          )
        
        :

Writes long integer to the end of file

Arguments

$value: integer

Details

visibility: public
final: false
static: false
throws

writeLong32Bit
jump to class

writeLong32Bit(
          integer|float $value
          )
        
        :

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

Arguments

$value: integerfloat

Details

visibility: public
final: false
static: false
throws

writeString
jump to class

writeString(
          string $str
          )
        
        :

Writes a string to the end of file.

Arguments

$str: string

Details

visibility: public
final: false
static: false
throws

writeVInt
jump to class

writeVInt(
          integer $value
          )
        
        :

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

Arguments

$value: integer

Details

visibility: public
final: false
static: false

API Documentation

Search/Lucene/Storage/File.php

Description

Zend_Search_Lucene_Storage_Filejump to top

Description

Methods

_freadjump to class

Arguments

Output

Details

_fwritejump to class

Arguments

Details

flushjump to class

Output

Details

lockjump to class

Arguments

Output

Details

readBinaryjump to class

Output

Details

readBytejump to class

Output

Details

readBytesjump to class

Arguments

Output

Details

readIntjump to class

Output

Details

readLongjump to class

Output

Details

readLong32Bitjump to class

Output

Details

readStringjump to class

Output

Details

readVIntjump to class

Output

Details

seekjump to class

Arguments

Output

Details

telljump to class

Output

Details

unlockjump to class

Details

writeBytejump to class

Arguments

Details

writeBytesjump to class

Arguments

Details

writeIntjump to class

Arguments

Details

writeLongjump to class

Arguments

Details

writeLong32Bitjump to class

Arguments

Details

writeStringjump to class

Arguments

Details

writeVIntjump to class

Arguments

Details

Zend_Search_Lucene_Storage_File
jump to top

_fread
jump to class

_fwrite
jump to class

flush
jump to class

lock
jump to class

readBinary
jump to class

readByte
jump to class

readBytes
jump to class

readInt
jump to class

readLong
jump to class

readLong32Bit
jump to class

readString
jump to class

readVInt
jump to class

seek
jump to class

tell
jump to class

unlock
jump to class

writeByte
jump to class

writeBytes
jump to class

writeInt
jump to class

writeLong
jump to class

writeLong32Bit
jump to class

writeString
jump to class

writeVInt
jump to class