Zend_Search_Lucene_Storage_Directory_Filesystem Class Reference

Public Member Functions
	__construct ($path)
	Object constructor Checks if $path is a directory or tries to create it.
	close ()
	Closes the store.
	fileList ()
	Returns an array of strings, one for each file in the directory.
	createFile ($filename)
	Creates a new, empty file in the directory with the given $filename.
	deleteFile ($filename)
	Removes an existing $filename in the directory.
	purgeFile ($filename)
	Purge file if it's cached by directory object.
	fileExists ($filename)
	Returns true if a file with the given $filename exists.
	fileLength ($filename)
	Returns the length of a $filename in the directory.
	fileModified ($filename)
	Returns the UNIX timestamp $filename was last modified.
	renameFile ($from, $to)
	Renames an existing file in the directory.
	touchFile ($filename)
	Sets the modified time of $filename to now.
	getFileObject ($filename, $shareHandler=true)
	Returns a Zend_Search_Lucene_Storage_File object for a given $filename in the directory.
Public Member Functions inherited from Zend_Search_Lucene_Storage_Directory
	close ()
	Closes the store.
	fileList ()
	Returns an array of strings, one for each file in the directory.
	createFile ($filename)
	Creates a new, empty file in the directory with the given $filename.
	deleteFile ($filename)
	Removes an existing $filename in the directory.
	purgeFile ($filename)
	Purge file if it's cached by directory object.
	fileExists ($filename)
	Returns true if a file with the given $filename exists.
	fileLength ($filename)
	Returns the length of a $filename in the directory.
	fileModified ($filename)
	Returns the UNIX timestamp $filename was last modified.
	renameFile ($from, $to)
	Renames an existing file in the directory.
	touchFile ($filename)
	Sets the modified time of $filename to now.
	getFileObject ($filename, $shareHandler=true)
	Returns a Zend_Search_Lucene_Storage_File object for a given $filename in the directory.

Static Public Member Functions
static	getDefaultFilePermissions ()
	Get default file permissions.
static	setDefaultFilePermissions ($mode)
	Set default file permissions.
static	mkdirs ($dir, $mode=0777, $recursive=true)
	Utility function to recursive directory creation.

Protected Attributes
	$_dirPath = null
	$_fileHandlers

Static Protected Attributes
static	$_defaultFilePermissions = 0666

Constructor & Destructor Documentation

__construct

(

$path

)

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

Parameters

string

$path

Exceptions

Zend_Search_Lucene_Exception

Member Function Documentation

close

(

)

Closes the store.

Returns

void

createFile

(

$filename

)

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

Parameters

string

$filename

Returns

Zend_Search_Lucene_Storage_File

Exceptions

Zend_Search_Lucene_Exception

deleteFile

(

$filename

)

Removes an existing $filename in the directory.

Parameters

string

$filename

Returns

void

Exceptions

Zend_Search_Lucene_Exception

fileExists

(

$filename

)

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

Parameters

string

$filename

Returns

boolean

fileLength

(

$filename

)

Returns the length of a $filename in the directory.

Parameters

string

$filename

Returns

integer

fileList

(

)

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

Returns

array

fileModified

(

$filename

)

Returns the UNIX timestamp $filename was last modified.

Parameters

string

$filename

Returns

integer

static getDefaultFilePermissions ( )

static

Get default file permissions.

Returns

integer

getFileObject	(		$filename,
			$shareHandler = true
	)

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

Parameters

string	$filename
boolean	$shareHandler

Returns

Zend_Search_Lucene_Storage_File

static mkdirs (   $dir,   $mode = 0777,   $recursive = true  )

static

Utility function to recursive directory creation.

Parameters

string	$dir
integer	$mode
boolean	$recursive

Returns

boolean

purgeFile

(

$filename

)

Purge file if it's cached by directory object.

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

Parameters

string

$filename

Returns

void

renameFile	(		$from,
			$to
	)

Renames an existing file in the directory.

Parameters

string	$from
string	$to

Returns

void

Exceptions

Zend_Search_Lucene_Exception

static setDefaultFilePermissions (   $mode )

static

Set default file permissions.

Parameters

integer

$mode

touchFile

(

$filename

)

Sets the modified time of $filename to now.

Parameters

string

$filename

Returns

void

Member Data Documentation

$_defaultFilePermissions = 0666

staticprotected

$_dirPath = null

protected

$_fileHandlers

protected