Abstract Class Zend_Search_Lucene_Storage_Directory

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

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


	
			
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 purgeFile (string $filename)
 void renameFile (string $from, string $to)
 void touchFile (string $filename)
Methods
close (line 39)

Closes the store.

  • abstract:
  • access: public
void close ()

Redefined in descendants as:
createFile (line 54)

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

  • abstract:
  • access: public
Zend_Search_Lucene_Storage_File createFile (string $filename)
  • string $filename

Redefined in descendants as:
deleteFile (line 63)

Removes an existing $filename in the directory.

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

Redefined in descendants as:
fileExists (line 81)

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

  • abstract:
  • access: public
boolean fileExists (string $filename)
  • string $filename

Redefined in descendants as:
fileLength (line 90)

Returns the length of a $filename in the directory.

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

Redefined in descendants as:
fileList (line 46)

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

  • abstract:
  • access: public
array fileList ()

Redefined in descendants as:
fileModified (line 99)

Returns the UNIX timestamp $filename was last modified.

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

Redefined in descendants as:
getFileObject (line 133)

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

  • abstract:
  • access: public
Zend_Search_Lucene_Storage_File getFileObject (string $filename, [boolean $shareHandler = true])
  • string $filename
  • boolean $shareHandler

Redefined in descendants as:
purgeFile (line 73)

Purge file if it's cached by directory object

Method is used to prevent 'too many open files' error

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

Redefined in descendants as:
renameFile (line 109)

Renames an existing file in the directory.

  • abstract:
  • access: public
void renameFile (string $from, string $to)
  • string $from
  • string $to

Redefined in descendants as:
touchFile (line 118)

Sets the modified time of $filename to now.

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

Redefined in descendants as:

Documentation generated on Mon, 21 Jun 2010 15:17:11 -0400 by phpDocumentor 1.4.3