inc/classes/interfaces/io/directory/class_FrameworkDirectory.php

   1 <?php
   2 /**
   3  * An interface for directorties
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 interface FrameworkDirectory extends FrameworkInterface {
  25         /**
  26          * Read raw lines of data from a directory pointer and return the data
  27          *
  28          * @return      $currentEntry   Current entry from encapsulated iterator
  29          */
  30         function readRawDirectory ();
  31
  32         /**
  33          * Read lines from the current directory pointer except some parts
  34          *
  35          * @param       $except         Some parts of a directory we want to ignore. Valid: directory and file names, other values will be silently ignored
  36          * @return      string          Directory and/or file names read from the current directory pointer
  37          */
  38         function readDirectoryExcept (array $except = array());
  39
  40         /**
  41          * Close a directory source and set it's instance to null and the path name
  42          * to empty
  43          *
  44          * @return      void
  45          */
  46         function closeDirectory ();
  47
  48         /**
  49          * Getter for the directory pointer
  50          *
  51          * @return      $iteratorInstance       The directory pointer which shall be a valid directory resource
  52          */
  53         function getDirectoryIteratorInstance ();
  54
  55         /**
  56          * Getter for path name
  57          *
  58          * @return      $pathName       The current path name
  59          */
  60         function getPathName ();
  61 }
  62
  63 // [EOF]
  64 ?>