Class Zend_Search_Lucene_Storage_File_Filesystem

Description
  • license: New BSD License
  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

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

Zend_Search_Lucene_Storage_File
   |
   --Zend_Search_Lucene_Storage_File_Filesystem
Method Summary
 Zend_Search_Lucene_Storage_File_Filesystem __construct (string $filename, [string $mode = 'r+b'])
 void close ()
 boolean flush ()
 boolean lock (integer $lockType, [boolean $nonBlockinLock = false])
 integer seek (integer $offset, [integer $whence = SEEK_SET])
 integer size ()
 integer tell ()
 boolean unlock ()
 string _fread ([integer $length = 1])
 void _fwrite (string $data, [integer $length = null])
Methods
Constructor __construct (line 52)

Class constructor. Open the file.

  • access: public
Zend_Search_Lucene_Storage_File_Filesystem __construct (string $filename, [string $mode = 'r+b'])
  • string $filename
  • string $mode
close (line 118)

Close File object

  • access: public
void close ()
flush (line 110)

Flush output.

Returns true on success or false on failure.

  • access: public
boolean flush ()

Redefinition of:
Zend_Search_Lucene_Storage_File::flush()
Flush output.
lock (line 191)

Lock file

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

  • access: public
boolean lock (integer $lockType, [boolean $nonBlockinLock = false])
  • integer $lockType
  • boolean $nonBlockinLock

Redefinition of:
Zend_Search_Lucene_Storage_File::lock()
Lock file
seek (line 87)

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.) SEEK_CUR is the only supported offset type for compound files

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

Get the size of the already opened file

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

Get file position.

  • access: public
integer tell ()

Redefinition of:
Zend_Search_Lucene_Storage_File::tell()
Get file position.
unlock (line 207)

Unlock file

Returns true on success

  • access: public
boolean unlock ()

Redefinition of:
Zend_Search_Lucene_Storage_File::unlock()
Unlock file
_fread (line 147)

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

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::flush()
 Zend_Search_Lucene_Storage_File::lock()
 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::unlock()
 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 Thu, 18 Jan 2007 09:53:40 -0800 by phpDocumentor 1.3.1