Search/Lucene/Storage/Directory.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 license@zend.com 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_Directory
Package: Zend_Search_Lucene\Storage
Returns
- Children
- \Zend_Search_Lucene_Storage_Directory_Filesystem
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods
close() : voidabstract
Closes the store.
createFile(string $filename) : \Zend_Search_Lucene_Storage_Fileabstract
Creates a new, empty file in the directory with the given $filename.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $filename | string |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Storage_File |
deleteFile(string $filename) : voidabstract
Removes an existing $filename in the directory.
Parameters
| Name | Type | Description |
|---|---|---|
| $filename | string |
fileExists(string $filename) : booleanabstract
Returns true if a file with the given $filename exists.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $filename | string |
| Type | Description |
|---|---|
| boolean |
fileLength(string $filename) : integerabstract
Returns the length of a $filename in the directory.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $filename | string |
| Type | Description |
|---|---|
| integer |
fileList() : arrayabstract
Returns an array of strings, one for each file in the directory.
Returns
| Type | Description |
|---|---|
| array |
fileModified(string $filename) : integerabstract
Returns the UNIX timestamp $filename was last modified.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $filename | string |
| Type | Description |
|---|---|
| integer |
getFileObject(string $filename, boolean $shareHandler = true) : \Zend_Search_Lucene_Storage_Fileabstract
Returns a Zend_Search_Lucene_Storage_File object for a given $filename in the directory.
If $shareHandler option is true, then file handler can be shared between File Object
requests. It speed-ups performance, but makes problems with file position.
Shared handler are good for short atomic requests.
Non-shared handlers are useful for stream file reading (especial for compound files).
Parameters| Name | Type | Description |
|---|---|---|
| $filename | string | |
| $shareHandler | boolean |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Storage_File |
purgeFile(string $filename) : voidabstract
Purge file if it's cached by directory object
Method is used to prevent 'too many open files' error
Parameters| Name | Type | Description |
|---|---|---|
| $filename | string |
renameFile(string $from, string $to) : voidabstract
Renames an existing file in the directory.
Parameters
| Name | Type | Description |
|---|---|---|
| $from | string | |
| $to | string |
touchFile(string $filename) : voidabstract
Sets the modified time of $filename to now.
Parameters
| Name | Type | Description |
|---|---|---|
| $filename | string |