The name "Pointer" was to general, better use "FilePointer" to make it clear
authorRoland Haeder <roland@mxchange.org>
Sat, 10 Jan 2015 21:58:07 +0000 (22:58 +0100)
committerRoland Haeder <roland@mxchange.org>
Sat, 10 Jan 2015 21:58:07 +0000 (22:58 +0100)
that the implementing classes will be pointers on files.

Signed-off-by: Roland H├Ąder <roland@mxchange.org>
inc/classes/interfaces/io/class_FilePointer.php [new file with mode: 0644]
inc/classes/interfaces/io/class_Pointer.php [deleted file]
inc/classes/interfaces/io/pointer/class_InputPointer.php
inc/classes/interfaces/io/pointer/class_OutputPointer.php
inc/classes/main/class_BaseFrameworkSystem.php

diff --git a/inc/classes/interfaces/io/class_FilePointer.php b/inc/classes/interfaces/io/class_FilePointer.php
new file mode 100644 (file)
index 0000000..567eec9
--- /dev/null
@@ -0,0 +1,58 @@
+<?php
+/**
+ * An interface for file pointers
+ *
+ * @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 FilePointer extends FrameworkInterface {
+       /**
+        * Close a file source and set it's instance to null and the file name
+        * to empty.
+        *
+        * @return      void
+        * @throws      NullPointerException    If the file pointer instance is not set by setPointer()
+        * @throws      InvalidResourceException        If there is being set
+        */
+       function closeFile ();
+
+       /**
+        * Getter for the file pointer
+        *
+        * @return      $filePointer    The file pointer which shall be a valid file resource
+        */
+       function getPointer ();
+
+       /**
+        * Getter for file name
+        *
+        * @return      $fileName       The current file name
+        */
+       function getFileName ();
+
+       /**
+        * Determines whether the EOF has been reached
+        *
+        * @return      $isEndOfFileReached             Whether the EOF has been reached
+        */
+       function isEndOfFileReached ();
+}
+
+// [EOF]
+?>
diff --git a/inc/classes/interfaces/io/class_Pointer.php b/inc/classes/interfaces/io/class_Pointer.php
deleted file mode 100644 (file)
index cac8d57..0000000
+++ /dev/null
@@ -1,58 +0,0 @@
-<?php
-/**
- * An interface for pointers
- *
- * @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 Pointer extends FrameworkInterface {
-       /**
-        * Close a file source and set it's instance to null and the file name
-        * to empty.
-        *
-        * @return      void
-        * @throws      NullPointerException    If the file pointer instance is not set by setPointer()
-        * @throws      InvalidResourceException        If there is being set
-        */
-       function closeFile ();
-
-       /**
-        * Getter for the file pointer
-        *
-        * @return      $filePointer    The file pointer which shall be a valid file resource
-        */
-       function getPointer ();
-
-       /**
-        * Getter for file name
-        *
-        * @return      $fileName       The current file name
-        */
-       function getFileName ();
-
-       /**
-        * Determines whether the EOF has been reached
-        *
-        * @return      $isEndOfFileReached             Whether the EOF has been reached
-        */
-       function isEndOfFileReached ();
-}
-
-// [EOF]
-?>
index 35760ce..eb03253 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/>.
  */
-interface InputPointer extends StreamableInput, Pointer {
+interface InputPointer extends StreamableInput, FilePointer {
        /**
         * Read data a file pointer
         *
index 9ad7bcd..a4e0008 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/>.
  */
-interface OutputPointer extends StreamableOutput, Pointer {
+interface OutputPointer extends StreamableOutput, FilePointer {
        /**
         * Write data to a file pointer
         *
index a3774fc..9ff3c04 100644 (file)
@@ -1254,19 +1254,19 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        }
 
        /**
-        * Setter for InputOutputPointer instance
+        * Setter for FilePointer instance
         *
-        * @param       $pointerInstance        An instance of an InputOutputPointer class
+        * @param       $pointerInstance        An instance of an FilePointer class
         * @return      void
         */
-       protected final function setPointerInstance (InputOutputPointer $pointerInstance) {
+       protected final function setPointerInstance (FilePointer $pointerInstance) {
                $this->pointerInstance = $pointerInstance;
        }
 
        /**
-        * Getter for InputOutputPointer instance
+        * Getter for FilePointer instance
         *
-        * @return      $pointerInstance        An instance of an InputOutputPointer class
+        * @return      $pointerInstance        An instance of an FilePointer class
         */
        public final function getPointerInstance () {
                return $this->pointerInstance;