Class ZSearchFSDirectory

Description
Description | Methods (details)

FileSystem implementation of Directory abstraction.

Located in /incubator/Zend/Search/Lucene/storage/filesystem/ZSearchDirectoryFilesystem.php (line 37) 

ZSearchDirectory
   |
   --ZSearchFSDirectory
Method Summary
Description | Methods (details)
ZSearchFSDirectory __construct (string $path)
void close ()
ZSearchFile createFile (string $filename)
void deleteFile (string $filename)
boolean fileExists (string $filename)
integer fileLength (string $filename)
array fileList ()
integer fileModified (string $filename)
ZSearchFile getFileObject (string $filename)
boolean mkdirs (string $dir, [integer $mode = 0777], [boolean $recursive = true])
void renameFile (string $from, string $to)
void touchFile (string $filename)
Methods
Description | Methods (details)
Constructor __construct (line 87)

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

  • access: public
  • throws: Zend_Search_Lucene_Exception
ZSearchFSDirectory __construct (string $path)
  • string $path
close (line 108)

Closes the store.

  • access: public
void close ()
Redefinition of:
ZSearchDirectory::close()
Closes the store.
createFile (line 143)

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

  • access: public
ZSearchFile createFile (string $filename)
  • string $filename
Redefinition of:
ZSearchDirectory::createFile()
Creates a new, empty file in the directory with the given $filename.
deleteFile (line 160)

Removes an existing $filename in the directory.

  • access: public
void deleteFile (string $filename)
  • string $filename
Redefinition of:
ZSearchDirectory::deleteFile()
Removes an existing $filename in the directory.
fileExists (line 176)

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

  • access: public
boolean fileExists (string $filename)
  • string $filename
Redefinition of:
ZSearchDirectory::fileExists()
Returns true if a file with the given $filename exists.
fileLength (line 188)

Returns the length of a $filename in the directory.

  • access: public
integer fileLength (string $filename)
  • string $filename
Redefinition of:
ZSearchDirectory::fileLength()
Returns the length of a $filename in the directory.
fileList (line 119)

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

  • access: public
array fileList ()
Redefinition of:
ZSearchDirectory::fileList()
Returns an array of strings, one for each file in the directory.
fileModified (line 203)

Returns the UNIX timestamp $filename was last modified.

  • access: public
integer fileModified (string $filename)
  • string $filename
Redefinition of:
ZSearchDirectory::fileModified()
Returns the UNIX timestamp $filename was last modified.
getFileObject (line 253)

Returns a ZSearchFile object for a given $filename in the directory.

  • access: public
ZSearchFile getFileObject (string $filename)
  • string $filename
Redefinition of:
ZSearchDirectory::getFileObject()
Returns a ZSearchFile object for a given $filename in the directory.
mkdirs (line 65)

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
renameFile (line 216)

Renames an existing file in the directory.

  • access: public
void renameFile (string $from, string $to)
  • string $from
  • string $to
Redefinition of:
ZSearchDirectory::renameFile()
Renames an existing file in the directory.
touchFile (line 241)

Sets the modified time of $filename to now.

  • access: public
void touchFile (string $filename)
  • string $filename
Redefinition of:
ZSearchDirectory::touchFile()
Sets the modified time of $filename to now.

Inherited Methods

Inherited From ZSearchDirectory

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

Documentation generated on Wed, 08 Mar 2006 04:56:37 -0800 by phpDocumentor 1.3.0RC4