05.03.2008 15:59 - Autor: Roman Matěna
Sdílet Linkuj Jagg

Rekurzivní procházení adresářů s filtrem souborů

Ohledně SPL (Standard PHP Library Functions) rozšíření v PHP 5 se nikde moc nepíše. Funkce používám zejména k vypsání struktury adresářů, souborů nebo filtrovanému výpisu kompletního stromu souborů.


Zdrojový kód ke stažení directoryiterator.zip. 

Přejdu přímo ke kontrétnímu příkladu. Detailní popis Standard PHP Library Functions můžete nastudovat v manuálu.

Za úkol jsem si stanovil vytvořit třídy, jejichž cílem je procházet soubory a adresáře na základě filtru definovaného regulárním výrazem.

Nejprve začneme představením třídy DirectoryIterator.

  1. <?
  2. $it=new DirectoryIterator(dirname(__FILE__));
  3. foreach ($it as $itFile) {
  4. if (!$it->isDot()) {
  5. if (!$it->isDir()) {
  6. echo $itFile->getFileName()."<br/>";
  7. }
  8. }
  9. }
  10. ?>
     

V konstruktoru DirectoryIterator nastavíme objektu cestu k procházenému adresáři, použil jsem dirname(__FILE__), což je aktuální adresář, kde se skript nachází. Pomocí cyklu pak už jen procházíme jednotlivé položky. Prvně testujeme funkcí isDot() zda nejde o položku typu "." nebo ".." (adresářové odkazy na nadřízený prvek), pokud ano, pokračujeme na další položku cyklu. Další testovací podmínkou je isDir(), pokud ano pokračujeme na další položku. Pokud jsme se dostali na soubor, potom volám funkci getFileName(), která vrací název souboru. Kromě funkce getFileName máme možnost použít spousty dalších funkcí, například na zjištění cesty souboru, času vytvoření souboru apod.

Jednotlivé kroky budou stejné jako u ostatních tutoriálů na tomto webu. Prvně stanovením cíle a cílené programátorské techniky.

Seznam dílčích úkolů:

  1. Vypsat soubory a adresáře vyhovující filtru
  2. Vypsat jen soubory vyhovující filtru
  3. Vypsat soubory a adresáře vyhovující filtru včetně všech podadresářů
  4. Vypsat jen soubory vyhovující filtru včetně souborů ve všech podadresářích

1. Úkol č.1 - Jak vypsat soubory a adresáře vyhovující filtru

Chci vypsat adresáře a soubory, které začínají názvem clanek, čemuž odpovídá regulární výraz "^clanek". Nejdříve si stanovím kód, se kterým chci pracovat. Třídu, bych chtěl používat nějak takto:

  1. <?
  2. $it=new DirectoryIteratorFilter(dirname(__FILE__), "^clanek");
  3. foreach ($it as $itFile) {
  4. echo $itFile->getPath()." - ".$itFile->getFileName()."<br/>";
  5. }
  6. ?>

Ještě před testováním třídy jsem si vytvořil testovací data. Soubor testovaci-data.php vytvoří v adresáři, kde je uložen, 10 různých adresářů, v každém z nich dalších 5 adresářů a v každém adresáři 5 různých souborů. Dokáže docela zaneřádit počítač tak dávejte pozor jak to používáte.

Adresáře a soubory jsou vytvořeny a teď se pustíme do psaní kódu:

  1. class DirectoryIteratorFilter extends FilterIterator {
  2. private $_rx;
  3. public function __construct($path, $regex=null) {
  4. parent::__construct(new DirectoryIterator($path));
  5. $this->_rx= $regex;
  6. }
  7. public function accept() {
  8. $inner=$this->getInnerIterator();
  9. if ($inner->isDot()) return false;
  10. if ($this->_rx) return ereg($this->_rx, $inner->getFileName());
  11. return true;
  12. }
  13. public function key() {
  14. return $this->getInnerIterator()->getPathname();
  15. }
  16. }
  17. $it=new DirectoryIteratorFilter(dirname(__FILE__), "^clanek");
  18. foreach ($it as $itFile) {
  19.     echo $itFile->getPath()." - ".$itFile->getFileName()."<br/>";
  20. }

K filtrování souborů jsem využil vestavěnou SPL třídu FilterIterator. V konstruktoru parametrem vkládám cestu k procházenému adresáři a volám rodiče tedy FilterIterator s vytvořeným objektem DirectoryIterator. Dále je předáván regulární výraz pro vyhledávání, není povinný.

Funkce accept vrací true pro objekty, které projdou filtrem. Omezení máme dvojí, na prvním řádku se vyřadí objekty typu "." a ".." pomocí porovnání funkce isDot(), a na druhém řádku se používá k porovnání název souboru funkcí ereg s regulárním výrazem. Druhý řádek je testován jen v případě, že byl zadán regulární výraz. Ukázka.

2. Úkol č.2 - Jak vypsat jen soubory vyhovující filtru

Úkol je obdobný původnímu, jen rozšíříme filtr a podmínku, která nesmí nechat projít adresáře. Protože PHP vrací stejné objekty pro adresáře i pro soubory, nevidím důvod proč k stavbě třídy FileIteratorFilter nerozšířit původní třídu DirectoryIteratorFilter.

Tedy hlavní změna bude ve funkci accept, kde doplníme další podmínku. Původní třídu DirectoryIteratorFile jsem rozšířil takto:

  1. <?
  2. class DirectoryIteratorFilter extends FilterIterator {
  3. private $_rx, $_onlyFiles;
  4. public function __construct($path, $regex=null, $onlyFiles=0) {
  5. parent::__construct(new DirectoryIterator($path));
  6. $this->_rx=$regex;
  7. $this->_onlyFiles=$onlyFiles;
  8. }
  9. public function accept() {
  10. $inner=$this->getInnerIterator();
  11. if ($inner->isDot()) return false;
  12. if ($this->_onlyFiles) if ($inner->isDir()) return false;
  13. if ($this->_rx) return ereg($this->_rx, $inner->getFileName());
  14. return true;
  15. }
  16. public function key() {
  17. return $this->getInnerIterator()->getPathname();
  18. }
  19. }
  20. ?>

Nyní už třída DirectoryIteratorFilter filtruje i adresáře, pokud nastavíme promennou $onlyFiles v konstruktoru na hodnotu 1.

Použití FileIteratorFilter bude vypadat takto:

  1. <?
  2. class FileIteratorFilter extends DirectoryIteratorFilter {
  3. public function __construct($path, $regex=null) {
  4. parent::__construct($path, $regex, 1);
  5. }
  6. }
  7. ?>

 Její použití bude opět obdobné (ukázka):

  1. <?
  2. include("DirectoryIteratorFilter.php");
  3. include("FileIteratorFilter.php");
  4. $it=new FileIteratorFilter(dirname(__FILE__), "^clanek");
  5. foreach ($it as $itFile) {
  6. echo $itFile->getPath()." - ".$itFile->getFileName()."<br/>";
  7. }
  8. ?>

Úkol č.3 - Jak vypsat soubory a adresáře vyhovující filtru včetně všech podadresářů

I v tomto úkolu budu rozšiřovat to co už známe. Budou nutné menší úpravy a budeme používat jiný iterátor, ale změny budou minimální. A protože budu muset předávat jiný iterátor, rozšířil jsem původní třídu DirectoryIteratorFilter o dva řáky v konstruktoru. Jejich úkolem je rozeznat, zda proměnná $path je objekt, v tom případě předpokládáme, že se jedná o iterátor a předáme ho rodiči. Pokud není iterátor vytvoříme ho.

  1. <?
  2. class DirectoryIteratorFilter extends FilterIterator {
  3. private $_rx, $_onlyFiles;
  4. public function __construct($path, $regex=null, $onlyFiles=0) {
  5. if (is_object($path)) parent::__construct($path);
    else parent::__construct(new DirectoryIterator($path));
  6. $this->_rx=$regex;
  7. $this->_onlyFiles=$onlyFiles;
  8. }
  9. public function accept() {
  10. $inner=$this->getInnerIterator();
  11. if ($inner->isDot()) return false;
  12. if ($this->_onlyFiles) if ($inner->isDir()) return false;
  13. if ($this->_rx) return ereg($this->_rx, $inner->getFileName());
  14. return true;
  15. }
  16. public function key() {
  17. return $this->getInnerIterator()->getPathname();
  18. }
  19. }
  20. ?>

Třídu opět používáme obdobně (ukázka).

  1. <?
  2. include("DirectoryIteratorFilter.php");
  3. include("FileIteratorFilter.php");
  4. include("RecursiveDirectoryIteratorFilter.php");
  5. $it=new RecursiveDirectoryIteratorFilter(dirname(__FILE__), "^clanek");
  6. foreach ($it as $itFile) {
  7. echo $itFile->getPath()." - ".$itFile->getFileName()."<br/>";
  8. }
  9. ?>

Úkol č.4 - Jak vypsat jen soubory vyhovující filtru včetně všech podadresářů

V tomto úkolu už je snad vše jasné, tentokrát budeme rozšiřovat třídu RecursiveDirectoryIteratorFilter.

A to následovně:

  1. <?
  2. class RecursiveFileIteratorFilter extends RecursiveDirectoryIteratorFilter {
  3. public function __construct($path, $regex=null) {  
  4. parent::__construct($path, $regex, 1);
  5. }
  6. }
  7. ?>

Ukázka použití:

  1. <?
  2. include("DirectoryIteratorFilter.php");
  3. include("FileIteratorFilter.php");
  4. include("RecursiveDirectoryIteratorFilter.php");
  5. include("RecursiveFileIteratorFilter.php");
  6. $it=new RecursiveFileIteratorFilter(dirname(__FILE__), "^clanek");
  7. foreach ($it as $itFile) {
  8. echo $itFile->getPath()." - ".$itFile->getFileName()."<br/>";
  9. }
  10. ?>

Doufám, že to bylo srozumitelné a bude Vám to užitečné, pokud jsem se někde provinil proti principům OOP, kritiku vítám. Zároveň se těším na feedback ohledně používání tohoto kódu, není příliš testován.

podobné články

09.03.2008Reference a odkazování na objekty v PHP5(20%)

komentáře

RSS Komentáře k článku RSS Komentáře   Add to Google
Jméno
Název
Text
Lze používat Texy! syntax. Příklad syntaxe: "text odkazu":odkaz, **tučně**, *kurzíva*, `code`. PHP kód uzavírejte do <?php ... ?> a JavaScript do <script> ... </script>