Search/Lucene/Storage/Directory/Filesystem.php
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-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Search_Lucene
- Subpackage
- Storage
- Version
- $Id: Filesystem.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Search_Lucene_Storage_Directory_Filesystem
FileSystem implementation of Directory abstraction.
- Parent(s)
- \Zend_Search_Lucene_Storage_Directory
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
integer $_defaultFilePermissions = 438Default file permissions
438Details- Type
- integer
string $_dirPath = nullFilesystem path to the directory
nullDetails- Type
- string
array $_fileHandlers = Cache for Zend_Search_Lucene_Storage_File_Filesystem objects Array: filename => Zend_Search_Lucene_Storage_File object
- Type
- array
Methods
__construct(string $path) : voidObject constructor Checks if $path is a directory or tries to create it.
| Name | Type | Description |
|---|---|---|
| $path | string |
| Exception | Description |
|---|---|
| \Zend_Search_Lucene_Exception |
close() : voidCloses the store.
createFile(string $filename) : \Zend_Search_Lucene_Storage_FileCreates a new, empty file in the directory with the given $filename.
| Name | Type | Description |
|---|---|---|
| $filename | string |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Storage_File |
| Exception | Description |
|---|---|
| \Zend_Search_Lucene_Exception |
deleteFile(string $filename) : voidRemoves an existing $filename in the directory.
| Name | Type | Description |
|---|---|---|
| $filename | string |
| Exception | Description |
|---|---|
| \Zend_Search_Lucene_Exception |
fileExists(string $filename) : booleanReturns true if a file with the given $filename exists.
| Name | Type | Description |
|---|---|---|
| $filename | string |
| Type | Description |
|---|---|
| boolean |
fileLength(string $filename) : integerReturns the length of a $filename in the directory.
| Name | Type | Description |
|---|---|---|
| $filename | string |
| Type | Description |
|---|---|
| integer |
fileList() : arrayReturns an array of strings, one for each file in the directory.
| Type | Description |
|---|---|
| array |
fileModified(string $filename) : integerReturns the UNIX timestamp $filename was last modified.
| Name | Type | Description |
|---|---|---|
| $filename | string |
| Type | Description |
|---|---|
| integer |
getDefaultFilePermissions() : integerGet default file permissions
| Type | Description |
|---|---|
| integer |
getFileObject(string $filename, boolean $shareHandler = true) : \Zend_Search_Lucene_Storage_FileReturns 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).
| Name | Type | Description |
|---|---|---|
| $filename | string | |
| $shareHandler | boolean |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Storage_File |
mkdirs(string $dir, integer $mode = 511, boolean $recursive = true) : booleanUtility function to recursive directory creation
| Name | Type | Description |
|---|---|---|
| $dir | string | |
| $mode | integer | |
| $recursive | boolean |
| Type | Description |
|---|---|
| boolean |
purgeFile(string $filename) : voidPurge file if it's cached by directory object
Method is used to prevent 'too many open files' error
| Name | Type | Description |
|---|---|---|
| $filename | string |
renameFile(string $from, string $to) : voidRenames an existing file in the directory.
| Name | Type | Description |
|---|---|---|
| $from | string | |
| $to | string |
| Exception | Description |
|---|---|
| \Zend_Search_Lucene_Exception |
setDefaultFilePermissions(integer $mode) : voidSet default file permissions
| Name | Type | Description |
|---|---|---|
| $mode | integer |
touchFile(string $filename) : voidSets the modified time of $filename to now.
| Name | Type | Description |
|---|---|---|
| $filename | string |