php8.5
Home/ Manual/ spl / recursivedirectoryiterator/ RecursiveDirectoryIterator::getSubPath

RecursiveDirectoryIterator::getSubPath

PHP function Edit on GitHub ✎

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

Get sub path

Description

RecursiveDirectoryIterator::getSubPath(): string

Returns the sub path relative to the directory given in the constructor.

Parameters Parameters

Return Values

The sub path.

Examples

getSubPath() example

php
      $directory = '/tmp';
      
      $it = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($directory));
      
      foreach ($it as $file) {
          echo 'SubPathName: ' . $it->getSubPathName() . "\n";
          echo 'SubPath:     ' . $it->getSubPath() . "\n\n";
      }
    

The above example will output something similar to:

output
     SubPathName: fruit/apple.xml
     SubPath:     fruit
     
     SubPathName: stuff.xml
     SubPath:     
     
     SubPathName: veggies/carrot.xml
     SubPath:     veggies
    

See Also

  • RecursiveDirectoryIterator::getSubPathName
  • RecursiveDirectoryIterator::key

Source: reference/spl/recursivedirectoryiterator/getsubpath.xml · from the official PHP manual (php/doc-en)