pop-dir
, (*1)
, (*2)
Overview
pop-dir is a component for easily traversing files and subdirectories within a directory., (*3)
It is a component of the Pop PHP Framework., (*4)
Top, (*5)
Install
Install pop-dir using Composer., (*6)
composer require popphp/pop-dir
Or, require it in your composer.json file, (*7)
"require": {
"popphp/pop-dir" : "^4.0.2"
}
Top, (*8)
Quickstart
Traversing a directory
use Pop\Dir\Dir;
$dir = new Dir('my-dir');
foreach ($dir->getFiles() as $file) {
echo $file;
}
If you want to traverse the directory recursively and get the full path of each file., (*9)
use Pop\Dir\Dir;
$dir = new Dir('my-dir', [
'absolute' => true,
'recursive' => true
]);
foreach ($dir->getFiles() as $file) {
echo $file;
}
Top, (*10)
Options
The available boolean options for the $options array parameter are:, (*11)
$options = [
'absolute' => true, // store the absolute, full path of the items in the directory
'relative' => false // store the relative path of the items in the directory
'recursive' => true, // traverse the directory recursively
'filesOnly' => false, // store only files in the object (and not other directories)
];
The absolute and relative options cannot be used together., (*12)
If absolute is set to true, it will return the absolute path of the files and directories:, (*13)
'/home/path/file1.txt`
'/home/path/file2.txt`
If relative is set to true, it will return the relative path of the files and directories:, (*14)
'path/file1.txt`
'path/file2.txt`
If neither are passed, it will return only the base file names and directory names:, (*15)
'file1.txt`
'file2.txt`
Top, (*16)
Empty
The directory can be emptied with the emptyDir() method:, (*17)
use Pop\Dir\Dir;
$dir = new Dir('my-dir');
$dir->emptyDir();
The true flag will remove the actual directory as well (use with caution):, (*18)
$dir->emptyDir(true);
Top, (*19)
Wallogit.com
