3 * A class for directory reading and getting its contents, no recursion!
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 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 class FrameworkDirectoryPointer extends BaseFrameworkSystem {
26 * The current path we are working in
28 private $pathName = '';
31 * The directory iterator instance
33 private $directoryInstance = NULL;
36 * Protected constructor
38 protected function __construct () {
39 // Call parent constructor
40 parent::__construct(__CLASS__);
44 * Destructor for cleaning purposes, etc
46 public function __destruct() {
47 // Is there a resource pointer? Then we have to close the directory here!
48 if ($this->getDirectoryInstance() instanceof DirectoryIterator) {
49 // Try to close a directory
50 $this->closeDirectory();
53 // Call the parent destructor
58 * Create a directory pointer based on the given path. The path will also
61 * @param $pathName The path name we shall pass to opendir()
62 * @param $inConstructor If we are in de/con-structor or from somewhere else
63 * @return $pointerInstance A prepared instance of FrameworkDirectoryPointer
64 * @throws PathIsEmptyException If the provided path name is empty
65 * @throws InvalidPathStringException If the provided path name is not a string
66 * @throws PathIsNoDirectoryException If the provided path name is not valid
67 * @throws PathReadProtectedException If the provided path name is read-protected
68 * @todo Get rid of inConstructor, could be old-lost code.
70 public static final function createFrameworkDirectoryPointer ($pathName, $inConstructor = FALSE) {
71 // Some pre-sanity checks...
72 if (is_null($pathName)) {
77 throw new PathIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
79 } elseif (!is_string($pathName)) {
84 throw new InvalidPathStringException(NULL, self::EXCEPTION_INVALID_STRING);
86 } elseif (!is_dir($pathName)) {
91 throw new PathIsNoDirectoryException($pathName, self::EXCEPTION_INVALID_PATH_NAME);
93 } elseif (!is_readable($pathName)) {
98 throw new PathReadProtectedException($pathName, self::EXCEPTION_READ_PROTECED_PATH);
102 // Get an iterator for the directory
103 $directoryInstance = new DirectoryIterator($pathName);
105 // Create new instance
106 $pointerInstance = new FrameworkDirectoryPointer();
108 // Set directory pointer and path name
109 $pointerInstance->setDirectoryInstance($directoryInstance);
110 $pointerInstance->setPathName($pathName);
112 // Return the instance
113 return $pointerInstance;
117 * Read raw lines of data from a directory pointer and return the data
119 * @return $current Current entry from encapsulated iterator
121 public function readRawDirectory () {
122 // Can the next entry be read?
123 assert($this->getDirectoryInstance()->valid());
128 // Is it a dot directory?
129 if (!$this->getDirectoryInstance()->isDot()) {
130 // Read data from the directory pointer and return it
131 $current = $this->getDirectoryInstance()->current();
134 // Advance to next entry
135 $this->getDirectoryInstance()->next();
137 // Return found entry
142 * Read lines from the current directory pointer except some parts
144 * @param $except Some parts of a directory we want to ignore. Valid: directory and file names, other values will be silently ignored
145 * @return string Directory and/or file names read from the current directory pointer
147 public function readDirectoryExcept (array $except = array()) {
148 // No exceptions given?
149 if (count($except) == 0) {
150 // No exception given, so read all files and directories, but not recursive
151 self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: No exceptions given, please use readRawDirectory() instead!');
152 return $this->readRawDirectory();
155 // Read a raw line...
156 $rawLine = $this->readRawDirectory();
157 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: rawLine[' . gettype($rawLine) . ']=' . $rawLine);
159 // Shall we exclude directories?
160 if ((!is_null($rawLine)) && ($rawLine !== FALSE) && (!in_array($rawLine, $except))) {
162 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: rawLine[' . gettype($rawLine) . ']=' . $rawLine);
164 } elseif ((!is_null($rawLine)) && ($rawLine !== FALSE)) {
166 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: rawline[' . gettype($rawLine) . ']=' . $rawLine . ' - Recursive call!');
167 return $this->readDirectoryExcept($except);
170 // End pointer reached
171 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: Returning NULL!');
176 * Close a directory source and set it's instance to null and the path name
181 public function closeDirectory () {
182 // Close the directory by unsetting it
183 $this->setDirectoryInstance(NULL);
184 $this->setPathName('');
188 * Setter for the directory pointer
190 * @param $directoryInstance An instanceof a DirectoryIterator class or NULL to unset ("close") it.
193 protected final function setDirectoryInstance (DirectoryIterator $directoryInstance = NULL) {
194 // Set instance (or NULL)
195 $this->directoryInstance = $directoryInstance;
199 * Getter for the directory pointer
201 * @return $directoryInstance The directory pointer which shall be a valid directory resource
203 public final function getDirectoryInstance () {
204 return $this->directoryInstance;
208 * Setter for path name
210 * @param $pathName The new path name
213 public final function setPathName ($pathName) {
214 $pathName = (string) $pathName;
215 $this->pathName = $pathName;
219 * Getter for path name
221 * @return $pathName The current path name
223 public final function getPathName () {
224 return $this->pathName;