webfiori/file

Basic class library to read, write and view files using PHP.

v1.3.6 2024-04-29 20:08 UTC

Requires

• php: >=7.0
• webfiori/jsonx: 3.3.x

Requires (Dev)

• webfiori/http: *

MIT

• Ibrahim BinAlshikh

• php
• file
• upload
• files
• uploading

README

Basic class library to read, write and view files using PHP.

Content

• Supported PHP Versions
• Main Aim of The Library
• Usage
  • Reading a File
  • Creating New File
  • Appending to Existing File
  • Overriding a File
  • Encoding or Decoding of Files
    • Decoding
  • Reading and Storing Encoded Files
  • Display a File
  • Chunking File

Supported PHP Versions

Main Aim of The Library

The main aim of the library is to have an OOP abstraction that simplifies most common operations with files in PHP.

Usage

Reading a File

$file = new File('path/to/my/file.txt');
$file->read();

$fileData = $file->getRawData();
// Do anything you like with data string.

Also, it is possible to read a specific range of bytes by supplying the range to the method File::read()

$file = new File('path/to/my/file.txt');
//Read bytes 10-100 inclusive
$file->read(10, 100);

$fileData = $file->getRawData();

Creating New File

$file = new File('path/to/my/new/file.txt');

//The method File::create() is used to create new files
$file->create();
$file->setRawData('Hello World');
$file->write();

Appending to Existing File

$file = new File('path/to/my/old/file.txt');
$file->setRawData('Hello');
$file->write();
$file->setRawData(' World');
$file->write();

//Setting raw data before each call to the method File::write() will append to file.

Overriding a File

$file = new File('path/to/my/old/file.txt');
$file->setRawData('Hello');
$file->write();
$file->setRawData(' World');
$file->write(true);

//By supplying true as parameter to the method File::write(), the old content of the file will be overridden. 

Encoding or Decoding of Files

Base64 encoding and decoding is usually used to make sure that binary data is stored and transmitted reliably from one place to another. For more information, read here

Decoding

$file = new File('file.txt');

//'Hello World!' in base64
$encodedData = 'SGVsbG8gV29ybGQh';

$file->setRawData($encodedData, true);
$decoded = $file->getRawData();

//$decoded is now the string 'Hello World!'
//By supplying true as second parameter to the method File::setRawData(), the method will decode given data

$file = new File('file.txt');
$file->setRawData('Hello World');

$encoded = $file->getRawData(true);
//$encoded is now the string 'SGVsbG8gV29ybGQh'
//By supplying true as second parameter to the method File::getRawData(), the method will encode given data

Reading and Storing Encoded Files

The method File::writeEncoded() is used to write base 64 enceded binary files as follows.

$file = new File('my-img.png');
$file->writeEncoded();

//This will create new file with the name 'my-img.png.bin'

The method File::readDecoded() is used to read base 64 enceded binary files as follows.

$file = new File('some-binary-with-encoded.bin');
$file->readDecoded();
$decoded = $file->getRawData();

Display a File

The method File::view() is used to dispatch the content of the file to front-end. It also supports the header content-range which can be used to get partial file content.

$file = new File('some-pdf.pdf');
$file->read();
$file->view();

To trigger a download dialog in web browser, supply true as argument to the method File::view().

$file = new File('some-pdf.pdf');
$file->read();
$file->view(true);

Chunking Files

Usually, when a big file is stored in a database table, it is encoded then divided into smaller chunks, and each chunk is stored in a record. The class provides a single method for doing such procedure.

$file = new File('some-big-movie-file.mp4');
$file->read();

//The size of each chunk will be 1500 bytes and they will be base 64 encoded by default.
$dataChunks = $file->getChunks(1500);

foreach ($dataChunks as $chunk) {
    //......
}

Supplying false as second parameter to the method will disable base 64 encoding.