Also this has to be renamed ('Directory' already exists).
authorRoland Haeder <roland@mxchange.org>
Sun, 7 Dec 2014 18:56:59 +0000 (19:56 +0100)
committerRoland Haeder <roland@mxchange.org>
Sun, 7 Dec 2014 18:56:59 +0000 (19:56 +0100)
Signed-off-by: Roland H├Ąder <roland@mxchange.org>
inc/classes/interfaces/io/directory/class_Directory.php [deleted file]
inc/classes/interfaces/io/directory/class_FrameworkDirectory.php [new file with mode: 0644]
inc/classes/main/class_BaseFrameworkSystem.php
inc/classes/main/file_directories/directory/class_FrameworkDirectoryPointer.php

diff --git a/inc/classes/interfaces/io/directory/class_Directory.php b/inc/classes/interfaces/io/directory/class_Directory.php
deleted file mode 100644 (file)
index 993ced2..0000000
+++ /dev/null
@@ -1,64 +0,0 @@
-<?php
-/**
- * An interface for directorties
- *
- * @author             Roland Haeder <webmaster@shipsimu.org>
- * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
- * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.shipsimu.org
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-interface Directory extends FrameworkInterface {
-       /**
-        * Read raw lines of data from a directory pointer and return the data
-        *
-        * @return      $currentEntry   Current entry from encapsulated iterator
-        */
-       function readRawDirectory ();
-
-       /**
-        * Read lines from the current directory pointer except some parts
-        *
-        * @param       $except         Some parts of a directory we want to ignore. Valid: directory and file names, other values will be silently ignored
-        * @return      string          Directory and/or file names read from the current directory pointer
-        */
-       function readDirectoryExcept (array $except = array());
-
-       /**
-        * Close a directory source and set it's instance to null and the path name
-        * to empty
-        *
-        * @return      void
-        */
-       function closeDirectory ();
-
-       /**
-        * Getter for the directory pointer
-        *
-        * @return      $iteratorInstance       The directory pointer which shall be a valid directory resource
-        */
-       function getDirectoryIteratorInstance ();
-
-       /**
-        * Getter for path name
-        *
-        * @return      $pathName       The current path name
-        */
-       function getPathName ();
-}
-
-// [EOF]
-?>
diff --git a/inc/classes/interfaces/io/directory/class_FrameworkDirectory.php b/inc/classes/interfaces/io/directory/class_FrameworkDirectory.php
new file mode 100644 (file)
index 0000000..0a06998
--- /dev/null
@@ -0,0 +1,64 @@
+<?php
+/**
+ * An interface for directorties
+ *
+ * @author             Roland Haeder <webmaster@shipsimu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.shipsimu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+interface FrameworkDirectory extends FrameworkInterface {
+       /**
+        * Read raw lines of data from a directory pointer and return the data
+        *
+        * @return      $currentEntry   Current entry from encapsulated iterator
+        */
+       function readRawDirectory ();
+
+       /**
+        * Read lines from the current directory pointer except some parts
+        *
+        * @param       $except         Some parts of a directory we want to ignore. Valid: directory and file names, other values will be silently ignored
+        * @return      string          Directory and/or file names read from the current directory pointer
+        */
+       function readDirectoryExcept (array $except = array());
+
+       /**
+        * Close a directory source and set it's instance to null and the path name
+        * to empty
+        *
+        * @return      void
+        */
+       function closeDirectory ();
+
+       /**
+        * Getter for the directory pointer
+        *
+        * @return      $iteratorInstance       The directory pointer which shall be a valid directory resource
+        */
+       function getDirectoryIteratorInstance ();
+
+       /**
+        * Getter for path name
+        *
+        * @return      $pathName       The current path name
+        */
+       function getPathName ();
+}
+
+// [EOF]
+?>
index ae19aeb..d5a5614 100644 (file)
@@ -199,7 +199,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        private $minableInstance = NULL;
 
        /**
-        * A Directory instance
+        * A FrameworkDirectory instance
         */
        private $directoryInstance = NULL;
 
@@ -1325,19 +1325,19 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        }
 
        /**
-        * Setter for Directory instance
+        * Setter for FrameworkDirectory instance
         *
         * @param       $directoryInstance      A FrameworkDirectoryPointer instance
         * @return      void
         */
-       protected final function setDirectoryInstance (Directory $directoryInstance) {
+       protected final function setDirectoryInstance (FrameworkDirectory $directoryInstance) {
                $this->directoryInstance = $directoryInstance;
        }
 
        /**
-        * Getter for directory instance
+        * Getter for FrameworkDirectory instance
         *
-        * @return      $directoryInstance      A Directory instance
+        * @return      $directoryInstance      A FrameworkDirectory instance
         */
        protected final function getDirectoryInstance () {
                return $this->directoryInstance;
index 2d075cb..634d8a7 100644 (file)
@@ -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
         */