Class Zend_Search_Lucene_Storage_File_Filesystem

Description

Located in /Zend/Search/Lucene/Storage/File/Filesystem.php (line 36)

Zend_Search_Lucene_Storage_File
   |
   --Zend_Search_Lucene_Storage_File_Filesystem
Variable Summary
 resource $_fileHandle
Method Summary
 Zend_Search_Lucene_Storage_File_Filesystem __construct (string $filename, [string $mode = 'rb'])
 void close ()
 integer seek (integer $offset, [integer $whence = SEEK_SET])
 integer size ()
 integer tell ()
 string _fread ([integer $length = 1])
 void _fwrite (string $data, [integer $length = null])
Variables
resource $_fileHandle (line 43)

Resource of the open file

  • access: private
Methods
Constructor __construct (line 52)

Class constructor. Open the file.

  • access: public
Zend_Search_Lucene_Storage_File_Filesystem __construct (string $filename, [string $mode = 'rb'])
  • string $filename
  • string $mode

Redefinition of:
Zend_Search_Lucene_Storage_File::__construct()
Class constructor. Open the file.
close (line 106)

Close File object

  • access: public
void close ()
seek (line 86)

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.
size (line 119)

Get the size of the already opened file

  • access: public
integer size ()
tell (line 97)

Get file position.

  • access: public
integer tell ()

Redefinition of:
Zend_Search_Lucene_Storage_File::tell()
Get file position.
_fread (line 135)

Read a $length bytes from the file and advance 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 161)

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::__construct()
 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::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 Tue, 18 Apr 2006 11:55:02 -0700 by phpDocumentor 1.3.0RC3