Search/Lucene/Storage/Directory/Filesystem.php

Show:

inherited

Classes
- \Zend_Search_Lucene_Storage_Directory_Filesystem

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Search_Lucene
Subpackage: Storage
Version: $Id: Filesystem.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Search_Lucene_Storage_Directory_Filesystem
jump to top

Package: Zend\Search\Lucene\Storage

FileSystem implementation of Directory abstraction.

Parent(s): \Zend_Search_Lucene_Storage_Directory
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

integer $_defaultFilePermissions = 438

static

Default file permissions

Default value438Details

Type: integer

string $_dirPath = null

Filesystem path to the directory

Default valuenullDetails

Type: string

array $_fileHandlers

Cache for Zend_Search_Lucene_Storage_File_Filesystem objects Array: filename => Zend_Search_Lucene_Storage_File object

Details

Type: array

Methods

__construct(string $path) : void

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

Parameters

Name	Type	Description
$path	string

Throws

Exception	Description
\Zend_Search_Lucene_Exception

close() : void

Closes the store.

createFile(string $filename) : \Zend_Search_Lucene_Storage_File

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

Parameters

Name	Type	Description
$filename	string

Returns

Type	Description
\Zend_Search_Lucene_Storage_File

Throws

Exception	Description
\Zend_Search_Lucene_Exception

deleteFile(string $filename) : void

Removes an existing $filename in the directory.

Parameters

Name	Type	Description
$filename	string

Throws

Exception	Description
\Zend_Search_Lucene_Exception

fileExists(string $filename) : boolean

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

Parameters

Name	Type	Description
$filename	string

Returns

Type	Description
boolean

fileLength(string $filename) : integer

Returns the length of a $filename in the directory.

Parameters

Name	Type	Description
$filename	string

Returns

Type	Description
integer

fileList() : array

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

Returns

Type	Description
array

fileModified(string $filename) : integer

Returns the UNIX timestamp $filename was last modified.

Parameters

Name	Type	Description
$filename	string

Returns

Type	Description
integer

getDefaultFilePermissions() : integer

static

Get default file permissions

Returns

Type	Description
integer

getFileObject(string $filename, boolean $shareHandler = true) : \Zend_Search_Lucene_Storage_File

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

Name	Type	Description
$filename	string
$shareHandler	boolean

Returns

Type	Description
\Zend_Search_Lucene_Storage_File

mkdirs(string $dir, integer $mode = 511, boolean $recursive = true) : boolean

static

Utility function to recursive directory creation

Parameters

Name	Type	Description
$dir	string
$mode	integer
$recursive	boolean

Returns

Type	Description
boolean

purgeFile(string $filename) : void

Purge file if it's cached by directory object

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

Parameters

Name	Type	Description
$filename	string

renameFile(string $from, string $to) : void

Renames an existing file in the directory.

Parameters

Name	Type	Description
$from	string
$to	string

Throws

Exception	Description
\Zend_Search_Lucene_Exception

setDefaultFilePermissions(integer $mode) : void

static

Set default file permissions

Parameters

Name	Type	Description
$mode	integer

touchFile(string $filename) : void

Sets the modified time of $filename to now.

Parameters

Name	Type	Description
$filename	string

Search/Lucene/Storage/Directory/Filesystem.php

\Zend_Search_Lucene_Storage_Directory_Filesystemjump to top

Properties

Methods

\Zend_Search_Lucene_Storage_Directory_Filesystem
jump to top