framework/main/interfaces/io/directory/class_FrameworkDirectory.php

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