API Documentation

Zend/Search/Lucene/Storage/Directory.php

Show: inherited
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: Directory.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Search_Lucene_Storage_Directory

Package: Zend\Search\Lucene\Storage

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

Methods

methodpublicclose( ) : void
abstract

Closes the store.

methodpubliccreateFile( string $filename ) : \Zend_Search_Lucene_Storage_File
abstract

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
methodpublicdeleteFile( string $filename ) : void
abstract

Removes an existing $filename in the directory.

Parameters
Name Type Description
$filename string
methodpublicfileExists( string $filename ) : boolean
abstract

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

Parameters
Name Type Description
$filename string
Returns
Type Description
boolean
methodpublicfileLength( string $filename ) : integer
abstract

Returns the length of a $filename in the directory.

Parameters
Name Type Description
$filename string
Returns
Type Description
integer
methodpublicfileList( ) : array
abstract

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

Returns
Type Description
array
methodpublicfileModified( string $filename ) : integer
abstract

Returns the UNIX timestamp $filename was last modified.

Parameters
Name Type Description
$filename string
Returns
Type Description
integer
methodpublicgetFileObject( string $filename, boolean $shareHandler = true ) : \Zend_Search_Lucene_Storage_File
abstract

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
methodpublicpurgeFile( string $filename ) : void
abstract

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
methodpublicrenameFile( string $from, string $to ) : void
abstract

Renames an existing file in the directory.

Parameters
Name Type Description
$from string
$to string
methodpublictouchFile( string $filename ) : void
abstract

Sets the modified time of $filename to now.

Parameters
Name Type Description
$filename string
Documentation was generated by DocBlox 0.15.1.