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