Class ZSearchFileFilesystem

Description
Description | Methods (details)

Located in /incubator/Zend/Search/Lucene/storage/filesystem/ZSearchFileFilesystem.php (line 36) 

ZSearchFile
   |
   --ZSearchFileFilesystem
Method Summary
Description | Methods (details)
ZSearchFileFilesystem __construct (string $filename, [string $mode = 'rb'])
void __destruct ()
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])
Methods
Description | Methods (details)
Constructor __construct (line 53)

Class constructor. Open the file.

  • access: public
ZSearchFileFilesystem __construct (string $filename, [string $mode = 'rb'])
  • string $filename
  • string $mode
Redefinition of:
ZSearchFile::__construct()
Class constructor. Open the file.
Destructor __destruct (line 107)

Class destructor. Close the file.

  • access: public
void __destruct ()
Redefinition of:
ZSearchFile::__destruct()
Class destructor. Close the file.
close (line 116)

Close File object

  • access: public
void close ()
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.) Upon success, returns 0; otherwise, returns -1

  • access: public
integer seek (integer $offset, [integer $whence = SEEK_SET])
  • integer $offset
  • integer $whence
Redefinition of:
ZSearchFile::seek()
Sets the file position indicator and advances the file pointer.
size (line 129)

Get the size of the already opened file

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

Get file position.

  • access: public
integer tell ()
Redefinition of:
ZSearchFile::tell()
Get file position.
_fread (line 145)

Read a $length bytes from the file and advance the file pointer.

  • access: protected
string _fread ([integer $length = 1])
  • integer $length
Redefinition of:
ZSearchFile::_fread()
Reads $length number of bytes at the current position in the file and advances the file pointer.
_fwrite (line 171)

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:
ZSearchFile::_fwrite()
Writes $length number of bytes (all, if $length===null) to the end of the file.

Inherited Methods

Inherited From ZSearchFile

ZSearchFile::__construct()
ZSearchFile::readBinary()
ZSearchFile::readByte()
ZSearchFile::readBytes()
ZSearchFile::readInt()
ZSearchFile::readLong()
ZSearchFile::readString()
ZSearchFile::readVInt()
ZSearchFile::seek()
ZSearchFile::tell()
ZSearchFile::writeByte()
ZSearchFile::writeBytes()
ZSearchFile::writeInt()
ZSearchFile::writeLong()
ZSearchFile::writeString()
ZSearchFile::writeVInt()
ZSearchFile::_fread()
ZSearchFile::_fwrite()
ZSearchFile::__destruct()

Documentation generated on Wed, 08 Mar 2006 04:56:43 -0800 by phpDocumentor 1.3.0RC4