Docs For Class Zend_Search_Lucene_Storage_Directory_Filesystem

## Class Zend_Search_Lucene_Storage_Directory_Filesystem

Description

FileSystem implementation of Directory abstraction.

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

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

    Zend_Search_Lucene_Storage_Directory
       |
       --Zend_Search_Lucene_Storage_Directory_Filesystem

Method Summary
static boolean mkdirs (string $dir, [integer $mode = 0777], [boolean $recursive = true])
Zend_Search_Lucene_Storage_Directory_Filesystem __construct (string $path)
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
static method mkdirs (line 67)

Utility function to recursive directory creation

- access: public

static boolean mkdirs (string $dir, [integer $mode = 0777], [boolean $recursive = true])

- string $dir
- integer $mode
- boolean $recursive

Constructor __construct (line 89)

Object constructor Checks if $path is a directory or tries to create it.

- access: public
- throws: Zend_Search_Lucene_Exception

Zend_Search_Lucene_Storage_Directory_Filesystem __construct (string $path)

- string $path

close (line 110)

Closes the store.

- access: public

void close ()

Redefinition of:

Zend_Search_Lucene_Storage_Directory::close()
  Closes the store.

createFile (line 149)

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

- access: public

Zend_Search_Lucene_Storage_File createFile (string $filename)

- string $filename

Redefinition of:

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

deleteFile (line 166)

Removes an existing $filename in the directory.

- access: public

void deleteFile (string $filename)

- string $filename

Redefinition of:

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

fileExists (line 188)

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

- access: public

boolean fileExists (string $filename)

- string $filename

Redefinition of:

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

fileLength (line 201)

Returns the length of a $filename in the directory.

- access: public

integer fileLength (string $filename)

- string $filename

Redefinition of:

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

fileList (line 125)

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

- access: public

array fileList ()

Redefinition of:

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

fileModified (line 216)

Returns the UNIX timestamp $filename was last modified.

- access: public

integer fileModified (string $filename)

- string $filename

Redefinition of:

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

getFileObject (line 273)

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

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

- string $filename
- boolean $shareHandler

Redefinition of:

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

renameFile (line 229)

Renames an existing file in the directory.

- access: public

void renameFile (string $from, string $to)

- string $from
- string $to

Redefinition of:

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

touchFile (line 255)

Sets the modified time of $filename to now.

- access: public

void touchFile (string $filename)

- string $filename

Redefinition of:

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

#### Inherited Methods

Inherited From Zend_Search_Lucene_Storage_Directory

> Zend_Search_Lucene_Storage_Directory::close()
> Zend_Search_Lucene_Storage_Directory::createFile()
> Zend_Search_Lucene_Storage_Directory::deleteFile()
> Zend_Search_Lucene_Storage_Directory::fileExists()
> Zend_Search_Lucene_Storage_Directory::fileLength()
> Zend_Search_Lucene_Storage_Directory::fileList()
> Zend_Search_Lucene_Storage_Directory::fileModified()
> Zend_Search_Lucene_Storage_Directory::getFileObject()
> Zend_Search_Lucene_Storage_Directory::renameFile()
> Zend_Search_Lucene_Storage_Directory::touchFile()

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