RedVodkaJelly Logo

PHP Directory Search Class

POSTED AT 15:34 on 23rd May 2008

This is a PHP class that deals with finding different file types within directories.

You simply pass it the directory you want to search within and an array of file types your looking for and the script will return with an array of matching files. It traverses child directories by default and so you could search your whole system for a certain file type etc.

Source Code

  1. <?php 
  2. /* 
  3. * 
  4. * Directory File Search Class 
  5. * 
  6. * Class to search a directory for files. 
  7. * 
  8. * Written By Jacob Wyke - jacob@redvodkajelly.com - www.redvodkajelly.com - and Jon Guymer. 
  9. * 
  10. * LICENSE 
  11. * ——- 
  12. * Feel free to use this as you wish, just give me credit where credits due and drop me an email telling me what your using it for so I can check out all the cool ways its been used. 
  13. * 
  14. * USAGE 
  15. * —– 
  16. * 
  17. * Call the class with the required parameters and the results of the search will be stored in $arrFilesFound. 
  18. * 
  19. *   $objDirectorySearch = new RVJ_DirectorySearch(’C:\myFolder’, array(’txt’, ‘doc’)); 
  20. * 
  21. * This will then search all files and folders within "C:\myFolder\" for any .txt or .doc files and return the results in $arrFilesFound. 
  22. * 
  23. *   print_r($objDirectorySearch->arrFilesFound); 
  24. * 
  25. * To only search the selected folder and NOT traverse to other folders add the third parameter. 
  26. * 
  27. *   $objDirectorySearch = new RVJ_Directory(’C:\myFolder’, array(’txt’, ‘doc’), 0); 
  28. * 
  29. * If you are running this script on Unix/Linux/OS X then make sure you change the $strPathDivider to ‘/’ on line 39. 
  30. */ 
  31.  
  32. class RVJ_DirectorySearch { 
  33.     
  34.    var $strDirectory; 
  35.    var $strCurrentDirectory; 
  36.    var $arrFileTypes = array(); 
  37.    var $boolTraverse = 1; 
  38.    var $arrFilesFound = array(); 
  39.    var $strPathDivider = "\\"; 
  40.  
  41.    /* 
  42.    * 
  43.    *   @Method:      RVJ_DirectorySearch 
  44.    *   @Parameters:   3 
  45.    *   @Param-1:      strDirectory - String - The directory path 
  46.    *   @Param-2:      arrFileTypes - Array - An array of file types to find 
  47.    *   @Param-3:      boolTraverse - Bool - If you want to traverse directorys to look for files deeper in the file structure 
  48.    *   @Description:   Finds files within a directory 
  49.    * 
  50.    */    
  51.    function RVJ_DirectorySearch($strDirectory, $arrFileTypes = ‘0′, $boolTraverse = ‘1′){ 
  52.       $this->strDirectory = $strDirectory; 
  53.       $this->arrFileTypes = $arrFileTypes; 
  54.       $this->boolTraverse = $boolTraverse; 
  55.        
  56.       $this->getDirectoryContent($this->strDirectory);       
  57.    } 
  58.     
  59.    /* 
  60.    * 
  61.    *   @Method:      getDirectoryContent 
  62.    *   @Parameters:   1 
  63.    *   @Param-1:      strDirectory - String - The directory path 
  64.    *   @Description:   Gets the content of a passed directory path 
  65.    * 
  66.    */ 
  67.    function getDirectoryContent($strDirectory){       
  68.       //opens the directory up 
  69.       if($resHandle = opendir($strDirectory)){ 
  70.          //reads the directories content 
  71.          while (false !== ($strFile = readdir($resHandle))){  
  72.             if($strFile <> ‘.’ AND $strFile <> ‘..’){           
  73.                $strFullFilePath = $strDirectory.$this->strPathDivider.$strFile; 
  74.                  
  75.                if($this->boolTraverse AND is_dir($strFullFilePath)){                   
  76.                   $this->getDirectoryContent($strFullFilePath); 
  77.                }else{                 
  78.                   if($this->arrFileTypes){                   
  79.                      $arrFileParts = explode(".", $strFile); 
  80.                      $arrFileParts = array_reverse($arrFileParts); 
  81.                      $strFileExt = $arrFileParts[0]; 
  82.                       
  83.                      if(in_array($strFileExt, $this->arrFileTypes)){ 
  84.                         $this->arrFilesFound[] = $strFullFilePath; 
  85.                      }                   
  86.                   }else{ 
  87.                      $this->arrFilesFound[] = $strFullFilePath; 
  88.                   }                   
  89.                }                
  90.             }     
  91.          } 
  92.          closedir($resHandle);  
  93.       } 
  94.    } 
  95.     
  96. } 
  97.  
  98. ?>