[Sommaire] [Imprimer]

   1  <?php
   2  /**
   3   * Zend Framework
   4   *
   5   * LICENSE
   6   *
   7   * This source file is subject to version 1.0 of the Zend Framework
   8   * license, that is bundled with this package in the file LICENSE, and
   9   * is available through the world-wide-web at the following URL:
  10   * http://www.zend.com/license/framework/1_0.txt. If you did not receive
  11   * a copy of the Zend Framework license and are unable to obtain it
  12   * through the world-wide-web, please send a note to license@zend.com
  13   * so we can mail you a copy immediately.
  14   *
  15   * @package    Zend_Search_Lucene
  16   * @subpackage Storage
  17   * @copyright  Copyright (c) 2005-2006 Zend Technologies USA Inc. (http://www.zend.com)
  18   * @license    http://www.zend.com/license/framework/1_0.txt Zend Framework License version 1.0
  19   */
  20  
  21  
  22  /**
  23   * @package    Zend_Search_Lucene
  24   * @subpackage Storage
  25   * @copyright  Copyright (c) 2005-2006 Zend Technologies USA Inc. (http://www.zend.com)
  26   * @license    http://www.zend.com/license/framework/1_0.txt Zend Framework License version 1.0
  27   */
  28  abstract class Zend_Search_Lucene_Storage_Directory
  29  {
  30  
  31      /**
  32       * Closes the store.
  33       *
  34       * @return void
  35       */
  36      abstract public function close();
  37  
  38      /**
  39       * Returns an array of strings, one for each file in the directory.
  40       *
  41       * @return array
  42       */
  43      abstract public function fileList();
  44  
  45      /**
  46       * Creates a new, empty file in the directory with the given $filename.
  47       *
  48       * @param string $filename
  49       * @return Zend_Search_Lucene_Storage_File
  50       */
  51      abstract public function createFile($filename);
  52  
  53  
  54      /**
  55       * Removes an existing $filename in the directory.
  56       *
  57       * @param string $filename
  58       * @return void
  59       */
  60      abstract public function deleteFile($filename);
  61  
  62  
  63      /**
  64       * Returns true if a file with the given $filename exists.
  65       *
  66       * @param string $filename
  67       * @return boolean
  68       */
  69      abstract public function fileExists($filename);
  70  
  71  
  72      /**
  73       * Returns the length of a $filename in the directory.
  74       *
  75       * @param string $filename
  76       * @return integer
  77       */
  78      abstract public function fileLength($filename);
  79  
  80  
  81      /**
  82       * Returns the UNIX timestamp $filename was last modified.
  83       *
  84       * @param string $filename
  85       * @return integer
  86       */
  87      abstract public function fileModified($filename);
  88  
  89  
  90      /**
  91       * Renames an existing file in the directory.
  92       *
  93       * @param string $from
  94       * @param string $to
  95       * @return void
  96       */
  97      abstract public function renameFile($from, $to);
  98  
  99  
 100      /**
 101       * Sets the modified time of $filename to now.
 102       *
 103       * @param string $filename
 104       * @return void
 105       */
 106      abstract public function touchFile($filename);
 107  
 108  
 109      /**
 110       * Returns a Zend_Search_Lucene_Storage_File object for a given $filename in the directory.
 111       *
 112       * @param string $filename
 113       * @return Zend_Search_Lucene_Storage_File
 114       */
 115      abstract public function getFileObject($filename);
 116  
 117  }
 118