Added the ignore_note_file_names search argument.

Author: michaeluno

README.md

@@ -71,13 +71,15 @@ This parameter accepts an array holding options.
  - `output_buffer`		: (boolean)	whether output buffer should be printed.     
  - `exclude_classes` 	: (array)   an array holding class names to exclude.
  - `base_dir_var`		: (string)	the variable or constant name that is prefixed before the inclusion path.
- - `output_var_name`	: (string)  The variable string that the map array is assigned to. Default: `$aClassMap`. If `return` is set, the variable will not be set but the file just returns the generated map array. 
+ - `output_var_name`	: (string)  the variable string that the map array is assigned to. Default: `$aClassMap`. If `return` is set, the variable will not be set but the file just returns the generated map array. 
+ - `do_in_constructor`  : (boolean) whether to perform the action in the constructor. Default: `true`.  
  - `search`				: (array)	the arguments for the directory search options.
     - `allowed_extensions`: (array) allowed file extensions to be listed. 
     - `exclude_dir_paths`: (array) directory paths to exclude from the list. 
     - `exclude_dir_names`: (array) directory base names to exclude from the list. 
     - `exclude_file_names`: (array) file names (with extension) to exclude from the list. 
-    - `is_recursive`: (boolean) whether to scan sub-directories. 
+    - `is_recursive`: (boolean) whether to scan sub-directories.
+    - `ignore_note_file_names`: (array) ignore note file names that tell the parser to skip the directory. When one of the files exist in the parsing directory, the directory will be skipped. Default: `[ 'ignore-class-map.txt' ]`,   
 
 ##### Example    
 ```php

changelog.md

@@ -1,6 +1,8 @@
 # Change Log
 
 ## 1.1.0 - 2020/09/14
+- Added the `ignore_note_file_names` search argument.
+- Added the `do_in_constructor` argument.
 - Supported no namespace classes.
 
 ## 1.0.1 - 2020/01/20

source/PHPClassMapGenerator.php

@@ -61,7 +61,9 @@ class PHPClassMapGenerator extends PHPClassMapGenerator_Base {
             'allowed_extensions'	=>	array( 'php' ),	// e.g. array( 'php', 'inc' )
             'exclude_dir_paths'		=>	array(),
             'exclude_dir_names'		=>	array(),
+            'exclude_file_names'     => array(),         // 1.0.3+ includes an file extension.
             'is_recursive'			=>	true,
+            'ignore_note_file_names' => array( 'ignore-class-map.txt' ) // 1.1.0 When this option is present and the parsing directory contains a file matching one of the set names, the directory will be skipped.
         ),
 
     );
@@ -178,8 +180,8 @@ protected function _do() {
      * @since   1.1.0
      */
     protected function _getOptionsFormatted( array $aOptions ) {
-        $aOptions			    = $aOptions + self::$_aStructure_Options;
-        $aOptions[ 'search' ]	= $aOptions[ 'search' ] + self::$_aStructure_Options[ 'search' ];
+        $aOptions			    = $aOptions + self::$_aStructure_Options + parent::$_aStructure_Options;
+        $aOptions[ 'search' ]	= $aOptions[ 'search' ] + self::$_aStructure_Options[ 'search' ] + parent::$_aStructure_Options[ 'search' ];
         return $aOptions;
     }
 

source/PHPClassMapGenerator_Base.php

@@ -33,11 +33,12 @@ public function __construct() {
 
         // Search options
         'search'    =>    array(
-            'allowed_extensions'    => array( 'php' ),    // e.g. array( 'php', 'inc' )
-            'exclude_dir_paths'     => array(),
-            'exclude_dir_names'     => array(),         // the directory 'base' name
-            'exclude_file_names'    => array(), // 1.0.3+ includes an file extension.
-            'is_recursive'          => true,
+            'allowed_extensions'     => array( 'php' ),  // e.g. array( 'php', 'inc' )
+            'exclude_dir_paths'      => array(),
+            'exclude_dir_names'      => array(),         // the directory 'base' name
+            'exclude_file_names'     => array(),         // 1.0.3+ includes an file extension.
+            'is_recursive'           => true,
+            'ignore_note_file_names' => array( 'ignore-class-map.txt' ) // 1.1.0 When this option is present and the parsing directory contains a file matching one of the set names, the directory will be skipped.
         ),        
 
         'carriage_return'   => PHP_EOL,
@@ -128,11 +129,34 @@ protected function _formatPaths( $asDirPaths ) {
                 protected function _getPathFormatted( $sPath ) {
                     return rtrim( str_replace( '\\', '/', $sPath ), '/' );
                 }
+
+
+            /**
+             * Checks whether a file exists.
+             *
+             * @remark  Checks all the paths given as array members and at least one of them exists, the method returns true.
+             * @param array $aFilePaths
+             * @param string $sSuffix The path suffix to prepend to the path set in the array.
+             * @return bool
+             */
+            private function ___fileExists( array $aFilePaths, $sSuffix='' ) {
+                foreach( $aFilePaths as $_sFilePath ) {
+                    if ( file_exists( $sSuffix . $_sFilePath ) ) {
+                        return true;
+                    }
+                }
+                return false;
+            }
+
             /**
              * The recursive version of the glob() function.
              */
             private function ___doRecursiveGlob( $sPathPatten, $nFlags=0, array $aExcludeDirPaths=array(), array $aExcludeDirNames=array(), array $aExcludeFileNames=array() ) {
 
+                if ( $this->___fileExists( $aIgnoreNotes, dirname( $sPathPatten ) . '/' ) ) {
+                    return array();
+                }
+
                 $_aFiles    = glob( $sPathPatten, $nFlags );    
                 $_aFiles    = is_array( $_aFiles ) ? $_aFiles : array();    // glob() can return false.
                 $_aFiles    = $this->___dropExcludingFiles( $_aFiles, $aExcludeFileNames );