popphp/pop-file

Pop File Component for Pop PHP Framework

pop-file

END OF LIFE

The pop-file component v2.1.0 is now end-of-life. The upload and dir sub-components have been forked and pushed into other repositories, respectively:, _(*1)

• popphp/pop-http (now the Pop\Http\Upload class)
• popphp/pop-dir (now the Pop\Dir\Dir class)

, _(*2)

OVERVIEW

pop-file is a component for managing file uploads and easily traversing files within a directory. With file uploads, you can set fine-grain controls to manage specific upload parameters like file types and file size. Also, you can traverse directories recursively as well., _(*3)

pop-fileis a component of the Pop PHP Framework., _(*4)

INSTALL

Install pop-file using Composer., _(*5)

composer require popphp/pop-file

BASIC USAGE

File uploads

Basic file upload

use Pop\File\Upload;

$upload = new Upload('/path/to/uploads');
$upload->useDefaults();

$upload->upload($_FILES['file_upload']);

// Do something with the newly uploaded file
if ($upload->isSuccess()) {
    $file = $upload->getUploadedFile();
} else {
    echo $upload->getErrorMessage();
}

The above code creates the upload object, sets the upload path and sets the basic defaults, which includes a max file size of 10MBs, and an array of allowed common file types as well as an array of common disallowed file types., _(*6)

File upload names and overwrites

By default, the file upload object will not overwrite a file of the same name. In the above example, if $_FILES['file_upload']['name'] is set to 'my_document.docx' and that file already exists in the upload path, it will be renamed to 'my_document_1.docx'., _(*7)

If you want to enable file overwrites, you can simply do this:, _(*8)

$upload->overwrite(true);

Also, you can give the file a direct name on upload like this:, _(*9)

$upload->upload($_FILES['file_upload'], 'my-custom-filename.docx');

And if you need to check for a duplicate filename first, you can use the checkFilename method. If the filename exists, it will append a '_1' to the end of the filename, or loop through until it finds a number that doesn't exist yet (_#). If the filename doesn't exist yet, it returns the original name., _(*10)

$filename = $upload->checkFilename('my-custom-filename.docx');

// $filename is set to 'my-custom-filename_1.docx'
$upload->upload($_FILES['file_upload'], $filename);

Directory traversal

Traversing a directory

use Pop\File\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., _(*11)

use Pop\File\Dir;

$dir = new Dir('my-dir', [
    'absolute'  => true,
    'recursive' => true
]);

foreach ($dir->getFiles() as $file) {
    echo $file;
}

The available boolean options for the $options array parameter are:, _(*12)

• 'absolute' => store the absolute, full path of the items in the directory
• 'relative' => store the relative path of the items in the directory
• 'recursive' => traverse the directory recursively
• 'filesOnly' => store only files in the object (and not other directories)

Emptying a directory

use Pop\File\Dir;

$dir = new Dir('my-dir');
$dir->emptyDir(true);

The true flag will remove the actually directory as well., _(*13)