Abstract Class Zend_Search_Lucene_Storage_Directory

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

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


	
			
Direct descendents
Class Description
 class Zend_Search_Lucene_Storage_Directory_Filesystem FileSystem implementation of Directory abstraction.
Method Summary
 void close ()
 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:
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:
deleteFile (line 62)

Removes an existing $filename in the directory.

  • access: public
  • abstract:
void deleteFile (string $filename)
  • string $filename

Redefined in descendants as:
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:
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:
fileList (line 45)

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

  • access: public
  • abstract:
array fileList ()

Redefined in descendants as:
fileModified (line 89)

Returns the UNIX timestamp $filename was last modified.

  • access: public
  • abstract:
integer fileModified (string $filename)
  • string $filename

Redefined in descendants as:
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:
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:
touchFile (line 108)

Sets the modified time of $filename to now.

  • access: public
  • abstract:
void touchFile (string $filename)
  • string $filename

Redefined in descendants as:

Documentation generated on Wed, 21 Feb 2007 11:47:00 -0800 by phpDocumentor 1.3.1