Search/Lucene/Storage/File/Filesystem.php
Show:
inherited
inherited
Classes
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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Search_Lucene
- Subpackage
- Storage
- Version
- $Id$
\Zend_Search_Lucene_Storage_File_Filesystem
Package: Zend_Search_Lucene\Storage
Returns
Returns
- Parent(s)
- \Zend_Search_Lucene_Storage_File
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
__construct(string $filename, string $mode = 'r+b') : voidClass constructor. Open the file.
Parameters
| Name | Type | Description |
|---|---|---|
| $filename | string | |
| $mode | string |
_fread(integer $length = 1) : stringRead a $length bytes from the file and advance the file pointer.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $length | integer |
| Type | Description |
|---|---|
| string |
_fwrite(string $data, integer $length = null) : voidWrites $length number of bytes (all, if $length===null) to the end of the file.
Parameters
| Name | Type | Description |
|---|---|---|
| $data | string | |
| $length | integer |
close() : voidClose File object
flush() : booleanFlush output.
Returns true on success or false on failure.
Returns| Type | Description |
|---|---|
| boolean |
lock(integer $lockType, boolean $nonBlockingLock = false) : booleanLock file
Lock type may be a LOCK_SH (shared lock) or a LOCK_EX (exclusive lock)
Parameters| Name | Type | Description |
|---|---|---|
| $lockType | integer | |
| $nonBlockingLock | boolean |
| Type | Description |
|---|---|
| boolean |
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
Parameters| Name | Type | Description |
|---|---|---|
| $offset | integer | |
| $whence | integer |
| Type | Description |
|---|---|
| integer |
size() : integerGet the size of the already opened file
Returns
| Type | Description |
|---|---|
| integer |
tell() : integerGet file position.
Returns
| Type | Description |
|---|---|
| integer |
unlock() : booleanUnlock file
Returns true on success
Returns| Type | Description |
|---|---|
| boolean |