3 namespace Org\Mxchange\CoreFramework\Filesystem;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
9 * An interface for directorties
11 * @author Roland Haeder <webmaster@shipsimu.org>
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
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.
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.
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/>.
30 interface FrameworkDirectory extends FrameworkInterface {
32 * Read raw lines of data from a directory pointer and return the data
34 * @return $currentEntry Current entry from encapsulated iterator
36 function readRawDirectory ();
39 * Read lines from the current directory pointer except some parts
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
44 function readDirectoryExcept (array $except = array());
47 * Close a directory source and set it's instance to null and the path name
52 function closeDirectory ();
55 * Getter for the directory pointer
57 * @return $iteratorInstance The directory pointer which shall be a valid directory resource
59 function getDirectoryIteratorInstance ();
62 * Getter for path name
64 * @return $pathName The current path name
66 function getPathName ();