Docs For Class Zend_Search_Lucene_Storage_Directory

## Class Zend_Search_Lucene_Storage_Directory

Description

- abstract:
- license: New BSD License
- copyright: Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Search/Lucene/Storage/Directory.php (line 30)

Direct descendents

Class | Description
--- | ---
Zend_Search_Lucene_Storage_Directory_Filesystem | FileSystem implementation of Directory abstraction.

Method Summary
void close ()
Zend_Search_Lucene_Storage_File createFile (string $filename)
void deleteFile (string $filename)
boolean fileExists (string $filename)
integer fileLength (string $filename)
array fileList ()
integer fileModified (string $filename)
Zend_Search_Lucene_Storage_File getFileObject (string $filename, [boolean $shareHandler = true])
void renameFile (string $from, string $to)
void touchFile (string $filename)
Methods
close (line 38)

Closes the store.

- access: public
- abstract:

void close ()

Redefined in descendants as:

- Zend_Search_Lucene_Storage_Directory_Filesystem::close() : Closes the store.

createFile (line 53)

Creates a new, empty file in the directory with the given $filename.

- access: public
- abstract:

Zend_Search_Lucene_Storage_File createFile (string $filename)

- string $filename

Redefined in descendants as:

- Zend_Search_Lucene_Storage_Directory_Filesystem::createFile() : Creates a new, empty file in the directory with the given $filename.

deleteFile (line 62)

Removes an existing $filename in the directory.

- access: public
- abstract:

void deleteFile (string $filename)

- string $filename

Redefined in descendants as:

- Zend_Search_Lucene_Storage_Directory_Filesystem::deleteFile() : Removes an existing $filename in the directory.

fileExists (line 71)

Returns true if a file with the given $filename exists.

- access: public
- abstract:

boolean fileExists (string $filename)

- string $filename

Redefined in descendants as:

- Zend_Search_Lucene_Storage_Directory_Filesystem::fileExists() : Returns true if a file with the given $filename exists.

fileLength (line 80)

Returns the length of a $filename in the directory.

- access: public
- abstract:

integer fileLength (string $filename)

- string $filename

Redefined in descendants as:

- Zend_Search_Lucene_Storage_Directory_Filesystem::fileLength() : Returns the length of a $filename in the directory.

fileList (line 45)

Returns an array of strings, one for each file in the directory.

- access: public
- abstract:

array fileList ()

Redefined in descendants as:

- Zend_Search_Lucene_Storage_Directory_Filesystem::fileList() : Returns an array of strings, one for each file in the directory.

fileModified (line 89)

Returns the UNIX timestamp $filename was last modified.

- access: public
- abstract:

integer fileModified (string $filename)

- string $filename

Redefined in descendants as:

- Zend_Search_Lucene_Storage_Directory_Filesystem::fileModified() : Returns the UNIX timestamp $filename was last modified.

getFileObject (line 123)

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).

- access: public
- abstract:

Zend_Search_Lucene_Storage_File getFileObject (string $filename, [boolean $shareHandler = true])

- string $filename
- boolean $shareHandler

Redefined in descendants as:

- Zend_Search_Lucene_Storage_Directory_Filesystem::getFileObject() : Returns a Zend_Search_Lucene_Storage_File object for a given $filename in the directory.

renameFile (line 99)

Renames an existing file in the directory.

- access: public
- abstract:

void renameFile (string $from, string $to)

- string $from
- string $to

Redefined in descendants as:

- Zend_Search_Lucene_Storage_Directory_Filesystem::renameFile() : Renames an existing file in the directory.

touchFile (line 108)

Sets the modified time of $filename to now.

- access: public
- abstract:

void touchFile (string $filename)

- string $filename

Redefined in descendants as:

- Zend_Search_Lucene_Storage_Directory_Filesystem::touchFile() : Sets the modified time of $filename to now.

Documentation generated on Sun, 29 Oct 2006 21:27:08 -0600 by phpDocumentor 1.3.0RC6