rcsofttech85/file-handler

A simple library for abstracting various file operations and providing additional helper functions for file manipulation

1.5.5 2023-10-12 10:03 UTC

Requires

• php: >8.2
• ext-ctype: *
• ext-fileinfo: *
• ext-sodium: *
• ext-zip: *
• symfony/config: ^6.3
• symfony/console: ^6.3
• symfony/dependency-injection: ^6.3
• symfony/dotenv: ^6.3
• symfony/process: ^6.3
• symfony/yaml: ^6.3

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10
• squizlabs/php_codesniffer: ^3.7
• symfony/var-dumper: ^6.3

MIT

• rahul

README

A simple PHP file helper for various file operations.

Table of Contents

• About
• Installation
• Usage
  • Search by Keyword
  • Search by keyword and return array
  • Write Multiple Files
  • Converting File to Array
  • Find and Replace in CSV
  • Converting File to JSON
  • Encrypt and Decrypt Files
  • Stream and Save Content from URL
  • File Compression and Decompression
  • File Difference
  • File Integrity check
  • View CSV in Terminal (table format)
  • View JSON in Terminal (table format)

About

This PHP File Helper is designed to simplify various file-related operations. It offers a range of features to handle tasks such as searching for keywords in files, converting files to different formats, encrypting and decrypting files, and more. Whether you're working with CSV, JSON, or plain text files, this library can streamline your file management processes.

Installation

You can install this PHP File Helper library via Composer:

composer require rcsofttech85/file-handler

Usage

search by keyword

     $temp = new TempFileHandler();
     $csv = new CsvFileHandler($temp);

     $findByKeyword = $csv->searchInCsvFile("movies.csv","Twilight","Film");

Search and return array

$temp = new TempFileHandler();
$csv = new CsvFileHandler($temp);

$findByKeyword = $csv->searchInCsvFile("movies.csv","Twilight","Film",FileHandler::ARRAY_FORMAT);

// output

[
    [Film] => Twilight
    [Genre] => Romance
    [Lead Studio] => Summit
    [Audience score %] => 82
    [Profitability] => 10.18002703
    [Rotten Tomatoes %] => 49
    [Worldwide Gross] => $376.66 
    [Year] => 2008


 ];

Write multiple files simultaneously

$fileHandler = new FileHandler();

$fileHandler->open('file.txt');

$fileHandler->open('php://stdout');

$fileHandler->write(data: "hello world");

$fileHandler->close();

Converting file to an array

$temp = new TempFileHandler();
$csv = new CsvFileHandler($temp);

$findByKeyword = $csv->toArray("movies.csv");
// output
$data[0] = [
            'Film' => 'Zack and Miri Make a Porno',
            'Genre' => 'Romance',
            'Lead Studio' => 'The Weinstein Company',
            'Audience score %' => '70',
            'Profitability' => '1.747541667',
            'Rotten Tomatoes %' => '64',
            'Worldwide Gross' => '$41.94 ',
            'Year' => '2008'

        ];

Find and replace in csv file

$temp = new TempFileHandler();
$csv = new CsvFileHandler($temp);

$findByKeyword = $csv->findAndReplaceInCsv("movies.csv","Twilight","Inception");

Find and replace a specific keyword in a particular column of a CSV file

$temp = new TempFileHandler();
$csv = new CsvFileHandler($temp);

$findByKeyword = $csv->findAndReplaceInCsv("movies.csv","Inception","Twilight",column: "Film");

Converting file to json format

$temp = new TempFileHandler();
$csv = new CsvFileHandler($temp);

$findByKeyword = $csv->toJson("movies.csv");

//output
[{"Film":"Zack and Miri Make a Porno","Genre":"Romance","Lead Studio":"The Weinstein Company","Audience score %":"70","Profitability":"1.747541667","Rotten Tomatoes %":"64","Worldwide Gross":"$41.94 ","Year":"2008"},{"Film":"Youth in Revolt","Genre":"Comedy","Lead Studio":"The Weinstein Company","Audience score %":"52","Profitability":"1.09","Rotten Tomatoes %":"68","Worldwide Gross":"$19.62 ","Year":"2010"},{"Film":"Twilight","Genre":"Romance","Lead Studio":"Independent","Audience score %":"68","Profitability":"6.383363636","Rotten Tomatoes %":"26","Worldwide Gross":"$702.17 ","Year":"2011"}]

Encrypt and decrypt files

$secret = getenv('SECRET_KEY');

$fileEncryptor = new FileEncryptor('movie.csv', $secret);
$fileEncryptor->encryptFile();
$fileEncryptor->decryptFile();

Stream and save content from url to file

 $url = "https://gist.github.com/rcsofttech85/629b37d483c4796db7bdcb3704067631#file-gistfile1-txt";
 $stream = new Stream($url, "outputFile.html");
 $stream->startStreaming();

File compression and decompression

        $testFile = 'movie.csv';
        $compressedZipFilename = 'compressed.zip';

        $this->fileHandler->compress($testFile, $compressedZipFilename);



        $compressedZipFilename = 'compressed.zip';
        $extractPath = 'extracted_contents';

        $this->fileHandler->decompress($compressedZipFilename, $extractPath);

File Difference

vendor/bin/file-diff oldFile newFile

File Integrity Check

$fileHasher = new FileHashChecker();

$fileHasher->hashFile(); 

$fileHasher->verifyHash($hashListFile);

View csv in terminal

vendor/bin/view-csv movies.csv --hide-column Film --limit 5

View json in terminal

vendor/bin/view-json movies.json --hide-column Film --limit 5

Applying filters to a csv file