Fixed parser error.

[core.git] / inc / classes / main / file_directories / directory / class_FrameworkDirectoryPointer.php

diff --git a/inc/classes/main/file_directories/directory/class_FrameworkDirectoryPointer.php b/inc/classes/main/file_directories/directory/class_FrameworkDirectoryPointer.php
index d2f47d3c93a8649fc0d5daa351afcabf0444d592..1cc296ca2a72761fd546ba2a6b5e07795dd75be9 100644 (file)
--- a/inc/classes/main/file_directories/directory/class_FrameworkDirectoryPointer.php
+++ b/inc/classes/main/file_directories/directory/class_FrameworkDirectoryPointer.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.shipsimu.org
  *
@@ -21,7 +21,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Directory {
+class FrameworkDirectoryPointer extends BaseFrameworkSystem implements FrameworkDirectory {
        /**
         * The current path we are working in
         */
@@ -45,7 +45,7 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Directory
         */
        public function __destruct() {
                // Is there a resource pointer? Then we have to close the directory here!
-               if ($this->getIteratorInstance() instanceof DirectoryIterator) {
+               if ($this->getDirectoryIteratorInstance() instanceof DirectoryIterator) {
                        // Try to close a directory
                        $this->closeDirectory();
                } // END - if
@@ -109,7 +109,7 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Directory
                $iteratorInstance->rewind();
 
                // Set directory pointer and path name
-               $pointerInstance->setIteratorInstance($iteratorInstance);
+               $pointerInstance->setDirectoryIteratorInstance($iteratorInstance);
                $pointerInstance->setPathName($pathName);
 
                // Return the instance
@@ -126,13 +126,13 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Directory
                //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . '] - CALLED!');
 
                // Can the next entry be read?
-               assert($this->getIteratorInstance()->valid());
+               assert($this->getDirectoryIteratorInstance()->valid());
 
                // Default is FALSE
                $currentEntry = FALSE;
 
                // Read data from the directory pointer and return it
-               $currentEntry = $this->getIteratorInstance()->current();
+               $currentEntry = $this->getDirectoryIteratorInstance()->current();
 
                // Return found entry
                //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: currentEntry[]=' . gettype($currentEntry) . ' - EXIT!');
@@ -151,7 +151,7 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Directory
                        // No exception given, so read all files and directories, but not recursive
                        self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: No exceptions given, please use readRawDirectory() instead!');
                        return $this->readRawDirectory();
-               } elseif (!$this->getIteratorInstance()->valid()) {
+               } elseif (!$this->getDirectoryIteratorInstance()->valid()) {
                        // No more left to read
                        return NULL;
                }
@@ -172,7 +172,7 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Directory
                        // Is it not excluded?
                        if (in_array($rawLine, $except)) {
                                // To next entry
-                               $this->getIteratorInstance()->next();
+                               $this->getDirectoryIteratorInstance()->next();
 
                                // Exclude this part
                                $rawLine = $this->readDirectoryExcept($except);
@@ -181,7 +181,7 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Directory
                } // END - if
 
                // To next entry
-               $this->getIteratorInstance()->next();
+               $this->getDirectoryIteratorInstance()->next();
 
                // Return read line
                //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DIRECTORY[' . __METHOD__ . ':' . __LINE__ . ']: rawLine[' . gettype($rawLine) . ']=' . $rawLine);
@@ -196,18 +196,18 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Directory
         */
        public function closeDirectory () {
                // Close the directory by unsetting it
-               $this->setIteratorInstance(NULL);
+               $this->unsetDirectoryIteratorInstance();
                $this->setPathName('');
        }
 
        /**
         * Setter for the directory pointer
         *
-        * @param       $iteratorInstance       An instanceof a DirectoryIterator class or NULL to unset ("close") it.
+        * @param       $iteratorInstance       An instanceof a DirectoryIterator class
         * @return      void
         */
-       protected final function setIteratorInstance (DirectoryIterator $iteratorInstance = NULL) {
-               // Set instance (or NULL)
+       protected final function setDirectoryIteratorInstance (DirectoryIterator $iteratorInstance) {
+               // Set instance
                $this->iteratorInstance = $iteratorInstance;
        }
 
@@ -216,10 +216,23 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Directory
         *
         * @return      $iteratorInstance       The directory pointer which shall be a valid directory resource
         */
-       public final function getIteratorInstance () {
+       public final function getDirectoryIteratorInstance () {
                return $this->iteratorInstance;
        }
 
+       /**
+        * Remove directory iterator instance (effectively closing it) by setting
+        * it to NULL. This will trigger a call on the destructor which will then
+        * "close" the iterator.
+        *
+        * @param       $iteratorInstance       An instanceof a DirectoryIterator class
+        * @return      void
+        */
+       protected final function unsetDirectoryIteratorInstance () {
+               // "Unset" the instance
+               $this->iteratorInstance = NULL;
+       }
+
        /**
         * Setter for path name
         *