3 * An interface for directorties
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 interface FrameworkDirectory extends FrameworkInterface {
26 * Read raw lines of data from a directory pointer and return the data
28 * @return $currentEntry Current entry from encapsulated iterator
30 function readRawDirectory ();
33 * Read lines from the current directory pointer except some parts
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
38 function readDirectoryExcept (array $except = array());
41 * Close a directory source and set it's instance to null and the path name
46 function closeDirectory ();
49 * Getter for the directory pointer
51 * @return $iteratorInstance The directory pointer which shall be a valid directory resource
53 function getDirectoryIteratorInstance ();
56 * Getter for path name
58 * @return $pathName The current path name
60 function getPathName ();