FileSystem implementation of Directory abstraction.
| category |
Zend |
| package |
Zend_Search_Lucene |
| subpackage |
Storage |
| copyright |
Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
| license |
New BSD License |
| inherited_from |
\Zend_Search_Lucene_Storage_Directory |
Methods
Object constructor
Checks if $path is a directory or tries to create it.
__construct(string $path)
Parameters
$path
string
Exceptions
\Zend_Search_Lucene_Exception |
|
Closes the store.
close() : void
| inherited_from |
\Zend_Search_Lucene_Storage_Directory::close() |
Closes the store.
close() : void
Inherited
Creates a new, empty file in the directory with the given $filename.
createFile(string $filename) : \Zend_Search_Lucene_Storage_File
| inherited_from |
\Zend_Search_Lucene_Storage_Directory::createFile() |
Parameters
$filename
string
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
\Zend_Search_Lucene_Storage_File
Creates a new, empty file in the directory with the given $filename.
createFile(string $filename) : \Zend_Search_Lucene_Storage_File
Inherited
Parameters
$filename
string
Returns
\Zend_Search_Lucene_Storage_File
Removes an existing $filename in the directory.
deleteFile(string $filename) : void
| inherited_from |
\Zend_Search_Lucene_Storage_Directory::deleteFile() |
Parameters
$filename
string
Exceptions
\Zend_Search_Lucene_Exception |
|
Removes an existing $filename in the directory.
deleteFile(string $filename) : void
Inherited
Parameters
$filename
string
Returns true if a file with the given $filename exists.
fileExists(string $filename) : boolean
| inherited_from |
\Zend_Search_Lucene_Storage_Directory::fileExists() |
Parameters
$filename
string
Returns
boolean
Returns true if a file with the given $filename exists.
fileExists(string $filename) : boolean
Inherited
Parameters
$filename
string
Returns
boolean
Returns the length of a $filename in the directory.
fileLength(string $filename) : integer
| inherited_from |
\Zend_Search_Lucene_Storage_Directory::fileLength() |
Parameters
$filename
string
Returns
integer
Returns the length of a $filename in the directory.
fileLength(string $filename) : integer
Inherited
Parameters
$filename
string
Returns
integer
Returns an array of strings, one for each file in the directory.
fileList() : array
| inherited_from |
\Zend_Search_Lucene_Storage_Directory::fileList() |
Returns
array
Returns an array of strings, one for each file in the directory.
fileList() : array
Inherited
Returns the UNIX timestamp $filename was last modified.
fileModified(string $filename) : integer
| inherited_from |
\Zend_Search_Lucene_Storage_Directory::fileModified() |
Parameters
$filename
string
Returns
integer
Returns the UNIX timestamp $filename was last modified.
fileModified(string $filename) : integer
Inherited
Parameters
$filename
string
Returns
integer
Get default file permissions
getDefaultFilePermissions() : integer
Static
Returns a Zend_Search_Lucene_Storage_File object for a given $filename in the directory.
getFileObject(string $filename, boolean $shareHandler = true) : \Zend_Search_Lucene_Storage_File
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).
| inherited_from |
\Zend_Search_Lucene_Storage_Directory::getFileObject() |
Parameters
$filename
string
$shareHandler
boolean
Returns
\Zend_Search_Lucene_Storage_File
Returns a Zend_Search_Lucene_Storage_File object for a given $filename in the directory.
getFileObject(string $filename, boolean $shareHandler = true) : \Zend_Search_Lucene_Storage_File
Inherited
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
$filename
string
$shareHandler
boolean
Returns
\Zend_Search_Lucene_Storage_File
Utility function to recursive directory creation
mkdirs(string $dir, integer $mode = 509, boolean $recursive = true) : boolean
Static
Parameters
$dir
string
$mode
integer
$recursive
boolean
Returns
boolean
Purge file if it's cached by directory object
purgeFile(string $filename) : void
Method is used to prevent 'too many open files' error
| inherited_from |
\Zend_Search_Lucene_Storage_Directory::purgeFile() |
Parameters
$filename
string
Purge file if it's cached by directory object
purgeFile(string $filename) : void
Inherited
Method is used to prevent 'too many open files' error
Parameters
$filename
string
Renames an existing file in the directory.
renameFile(string $from, string $to) : void
| inherited_from |
\Zend_Search_Lucene_Storage_Directory::renameFile() |
Parameters
$from
string
$to
string
Exceptions
\Zend_Search_Lucene_Exception |
|
Renames an existing file in the directory.
renameFile(string $from, string $to) : void
Inherited
Parameters
$from
string
$to
string
Set default file permissions
setDefaultFilePermissions(integer $mode)
Static
Sets the modified time of $filename to now.
touchFile(string $filename) : void
| inherited_from |
\Zend_Search_Lucene_Storage_Directory::touchFile() |
Parameters
$filename
string
Sets the modified time of $filename to now.
touchFile(string $filename) : void
Inherited
Parameters
$filename
string
Properties
Default file permissions
$_defaultFilePermissions : integer
Static
Filesystem path to the directory
$_dirPath : string
Cache for Zend_Search_Lucene_Storage_File_Filesystem objects
Array: filename => Zend_Search_Lucene_Storage_File object
$_fileHandlers : array
\Zend_Search_Lucene_Exception |
|