Search/Lucene/Storage/File/Filesystem.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: Filesystem.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Search_Lucene_Storage_File_Filesystem
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_Filesystem
- Extends from
- Zend_Search_Lucene_Storage_File
- 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
- Properties
- $_fileHandle
- Methods
- __construct
- seek
- tell
- flush
- close
- size
- _fread
- _fwrite
- lock
- unlock
Description
Properties
$_fileHandle
resource $_fileHandle = ''Resource of the open file
Details
- $_fileHandle
- resource
- visibility
- protected
- default
- final
- false
- static
- false
Methods
__construct
__construct(
string $filename, string $mode
=
r+b
)
:
Class constructor. Open the file.
Arguments
- $filename
- string
- $mode
- string
Details
- visibility
- public
- final
- false
- static
- false
_fread
_fread(
integer $length
=
1
)
:
stringRead a $length bytes from the file and advance the file pointer.
Arguments
- $length
- integer
Output
- string
Details
- visibility
- protected
- final
- false
- static
- false
_fwrite
_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
close
close(
)
:
Close File object
Details
- visibility
- public
- final
- false
- static
- false
flush
flush(
)
:
booleanFlush output.
Returns true on success or false on failure.
Output
- boolean
Details
- visibility
- public
- final
- false
- static
- false
lock
lock(
integer $lockType, boolean $nonBlockingLock
=
false
)
:
booleanLock file
Lock type may be a LOCK_SH (shared lock) or a LOCK_EX (exclusive lock)
Arguments
- $lockType
- integer
- $nonBlockingLock
- boolean
Output
- boolean
Details
- visibility
- public
- final
- false
- static
- false
seek
seek(
integer $offset, integer $whence
=
SEEK_SET
)
:
integerSets 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
Arguments
- $offset
- integer
- $whence
- integer
Output
- integer
Details
- visibility
- public
- final
- false
- static
- false
size
size(
)
:
integerGet the size of the already opened file
Output
- integer
Details
- visibility
- public
- final
- false
- static
- false
tell
tell(
)
:
integerGet file position.
Output
- integer
Details
- visibility
- public
- final
- false
- static
- false
unlock
unlock(
)
:
booleanUnlock file
Returns true on success
Output
- boolean
Details
- visibility
- public
- final
- false
- static
- false