Temporary added very noisy debug lines
[core.git] / inc / classes / main / io / class_FrameworkDirectoryPointer.php
index ba9b58c..253463c 100644 (file)
@@ -59,20 +59,13 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem {
         * be verified here.
         *
         * @param       $pathName               The path name we shall pass to opendir()
-        * @param       $inConstructor  If we are in de/con-structor or from somewhere
-        *                                                      else
-        * @return      $pointerInstance        A prepared instance of
-        *                                                              FrameworkDirectoryPointer
-        * @throws      PathIsEmptyException    If the provided path name
-        *                                                                      is empty
-        * @throws      InvalidPathStringException      If the provided path name is
-        *                                                                              not a string
-        * @throws      PathIsNoDirectoryException      If the provided path name is
-        *                                                                              not valid
-        * @throws      PathReadProtectedException      If the provided path name is
-        *                                                                              read-protected
-        * @throws      DirPointerNotOpened                     If opendir() returns not a
-        *                                                                              directory resource
+        * @param       $inConstructor  If we are in de/con-structor or from somewhere else
+        * @return      $pointerInstance        A prepared instance of FrameworkDirectoryPointer
+        * @throws      PathIsEmptyException    If the provided path name is empty
+        * @throws      InvalidPathStringException      If the provided path name is not a string
+        * @throws      PathIsNoDirectoryException      If the provided path name is not valid
+        * @throws      PathReadProtectedException      If the provided path name is read-protected
+        * @throws      DirPointerNotOpenedException    If opendir() returns not a directory resource
         */
        public static final function createFrameworkDirectoryPointer ($pathName, $inConstructor = false) {
                // Some pre-sanity checks...
@@ -131,8 +124,7 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem {
        /**
         * Read raw lines of data from a directory pointer and return the data
         *
-        * @return      string  Directory and/or file names read from the current
-        *                                      directory pointer
+        * @return      string  Directory and/or file names read from the current directory pointer
         */
        public function readRawDirectory () {
                // Read data from the directory pointer and return it
@@ -142,15 +134,13 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem {
        /**
         * Read lines from the current directory pointer except some parts
         *
-        * @param               $except Some parts of a directory we want to ignore.
-        *                                      Valid: dirs
-        *                                      Other values will be silently ignored
-        * @return      string  Directory and/or file names read from the current
-        *                                      directory pointer
+        * @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
         */
-       public function readDirectoryExcept (array $except = array()) {
+       public function readDirectoryExcept (array $except = array('.', '..')) {
                if (count($except) == 0) {
                        // No exception given, so read all data
+                       $this->debugOutput('DIRECTORY: No exceptions given, please use readRawDirectory() instead!');
                        return $this->readRawDirectory();
                } // END - if
 
@@ -160,16 +150,16 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem {
                // Shall we exclude directories?
                if ((!is_null($rawLine)) && ($rawLine !== false) && (!in_array($rawLine, $except))) {
                        // Return read data
-                       //* NOISY-DEBUG: */ $this->debugOutput('DIRECTORY: rawLine[' . gettype($rawLine) . ']=' . $rawLine);
+                       /* NOISY-DEBUG: */ $this->debugOutput('DIRECTORY: rawLine[' . gettype($rawLine) . ']=' . $rawLine);
                        return $rawLine;
                } elseif ((!is_null($rawLine)) && ($rawLine !== false)) {
                        // Exclude this part
-                       //* NOISY-DEBUG: */ $this->debugOutput('DIRECTORY: rawline[' . gettype($rawLine) . ']=' . $rawLine . ' - Recursive call!');
+                       /* NOISY-DEBUG: */ $this->debugOutput('DIRECTORY: rawline[' . gettype($rawLine) . ']=' . $rawLine . ' - Recursive call!');
                        return $this->readDirectoryExcept($except);
                }
 
                // End pointer reached
-               //* NOISY-DEBUG: */ $this->debugOutput('DIRECTORY: Returning NULL!');
+               /* NOISY-DEBUG: */ $this->debugOutput('DIRECTORY: Returning NULL!');
                return NULL;
        }
 
@@ -189,7 +179,7 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem {
        /**
         * Setter for the directory pointer
         *
-        * @param               $dirPointer     The directory resource
+        * @param       $dirPointer             The directory resource
         * @return      void
         */
        public final function setPointer ($dirPointer) {
@@ -206,8 +196,7 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem {
        /**
         * Getter for the directory pointer
         *
-        * @return      $dirPointer     The directory pointer which shall be a valid
-        *                                              directory resource
+        * @return      $dirPointer             The directory pointer which shall be a valid directory resource
         */
        public final function getPointer () {
                return $this->dirPointer;
@@ -216,7 +205,7 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem {
        /**
         * Setter for path name
         *
-        * @param               $pathName               The new path name
+        * @param       $pathName       The new path name
         * @return      void
         */
        public final function setPathName ($pathName) {
@@ -227,7 +216,7 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem {
        /**
         * Getter for path name
         *
-        * @return      $pathName               The current path name
+        * @return      $pathName       The current path name
         */
        public final function getPathName () {
                return $this->pathName;