README

Slick Spreadsheets is a utility to simplify common tasks for a structured data set file like csv/xls/xlsx/html. This package allows you to convert between formats, extract data from a file as an associative array and create a file from an array of data.

Installation

You can install the package via composer:

composer require itul/slick-spreadsheets

Methods

generate
General Conversion
- toArray
- toXls
- toCsv
- toHtml
Convert To XLSX
Convert To Csv
Convert To Html
Convert To PDF
- csvToPdf
- xlsToPdf

Generate/Convert/Download a File

All the below examples will trigger the browser to download a file.

//GENERATE CSV FROM AN ARRAY 
\SlickSpreadsheets::generate($array, '/path/to/output.csv');

//GENERATE XLSX FROM AN ARRAY
\SlickSpreadsheets::generate($array, '/path/to/output.xlsx');

//CONVERT CSV TO XLSX
\SlickSpreadsheets::generate('/path/to/example.csv', '/path/to/output.xlsx');

//CONVERT XLSX TO CSV
\SlickSpreadsheets::generate('/path/to/example.xlsx', '/path/to/output.csv');

General Conversion

All general conversion options (toArray,toXls,toCsv,toHtml) accept an array, or a file that can be read into the structured array.

toArray

The toArray method accepts a file path to convert to an array.

If the provided argument is just html, this package will try to convert the html table to an array.

Read File To Array Example

//CONVERT A CSV INTO A PHP ARRAY
$data = \SlickSpreadsheets::toArray('/path/to/file.csv');

//CONVERT A XLSX INTO A PHP ARRAY
$data = \SlickSpreadsheets::toArray('/path/to/file.xlsx');

When you are not using this package in Laravel, you will need to explicitly call the fully qualified package and run the init static method before using any of the available methods in this package.a

$data = \Itul\SlickSpreadsheets\SlickSpreadsheets::init()->toArray('/path/to/file.csv');

Examples

CSV to Array

//CSV To array example
$data = \SlickSpreadsheets::toArray('/path/to/file.csv');

XLS to Array

This method can accept both .xls and .xslx files.

//XLS To array example
//EACH SHEET IN THE SPREADSHEET WILL BE RETURNED IN THE DATA ARRAY
$data = \SlickSpreadsheets::toArray('/path/to/file.xlsx');

HTML to Array

This method can accept both .htm and .html files or raw html.

//HTML To array example
$data = \SlickSpreadsheets::toArray('/path/to/file.hml');

//HTML string To array example
$data = \SlickSpreadsheets::toArray('
    <table>
        <thead>
            <th>header1</th>
            <th>header2</th>
            <th>header3</th>
        </thead>
        <tbody>
            <tr>
                <td>row 1 col 1</td>
                <td>row 1 col 2</td>
                <td>row 1 col 3</td>
            </tr>
            <tr>
                <td>row 2 col 1</td>
                <td>row 2 col 2</td>
                <td>row 2 col 3</td>
            </tr>
            <tr>
                <td>row 3 col 1</td>
                <td>row 3 col 2</td>
                <td>row 3 col 3</td>
            </tr>
        </tbody>
    </table>
');

toCsv

This method can convert to .csv from: array, .xls, .xlsx, .htm, .html, '(string)html'

//CONVERT ARRAY TO CSV
$csvFile = \SlickSpreadsheets::toCsv(array $array);

//CONVERT XLS/XLSX TO CSV
$csvFile = \SlickSpreadsheets::toCsv('/path/to/source/file.xlsx');

//CONVERT HTML/HTM TO CSV
$csvFile = \SlickSpreadsheets::toCsv('/path/to/source/file.html');

//CONVERT HTML string to CSV
$csvFile = \SlickSpreadsheets::toCsv(`'<table>...</table>'`);

toXls

This method can convert to .xlsx from: array/htm/html/html string/csv

//CONVERT ARRAY TO CSV
$csvFile = \SlickSpreadsheets::toCsv(array $array);

//CONVERT XLS/XLSX TO CSV
$csvFile = \SlickSpreadsheets::toCsv('/path/to/source/file.xlsx');

//CONVERT HTML/HTM TO CSV
$csvFile = \SlickSpreadsheets::toCsv('/path/to/source/file.html');

//CONVERT HTML string to CSV
$csvFile = \SlickSpreadsheets::toCsv(`'<table>...</table>'`);

toHtml

All Examples below will return $html as a string.

//CONVERT ARRAY TO HTML
$html = \SlickSpreadsheets::toHtml(array $array);

//CONVERT CSV to HTML
$html = \SlickSpreadsheets::toCsv('/path/to/source/file.csv');

//CONVERT XLS/XLSX TO HTML
$html = \SlickSpreadsheets::html('/path/to/source/file.xlsx');

Convert To XLSX

Convert array to XLSX

$filePath = \SlickSpreadsheets::arrayToXls($data);

Convert CSV to XLSX

$filePath = \SlickSpreadhseets::csvToXls('/path/to/file.csv');

Convert html to XLSX

//PASS A HTML TABLE STRING
$filePath = \SlickSpreadhseets::htmlToXls($html);

Convert To CSV

Convert array to CSV

$filePath = \SlickSpreadsheets::arrayToCsv($data);

Convert XLSX to CSVS

//WILL RETURN AN ARRAY OF CSV FILE PATHS WITH A KEY NAME THAT MATCHES THE SHEET NAME
//FILE CAN BE .xls OR .xslx
$filePaths = \SlickSpreadhseets::xlsToCsv('/path/to/file.xlsx');

Convert html to CSV

//PASS A HTML TABLE STRING  
$filePath = \SlickSpreadhseets::htmlToCsv($html);

Convert to HTML

Convert Array to HTML

//RETURNS THE HTML AS A STRING
$html = \SlickSpreadhseets::arrayToHtml($data);

Convert CSV to HTML

//RETURNS THE HTML AS A STRING
$html = \SlickSpreadhseets::csvToHtml('/path/to/file.csv');

Convert XLSX to HTML

//RETURNS THE HTML AS A STRING
//FILE CAN BE .xls OR .xlsx
$html = \SlickSpreadhseets::xlsToHtml('/path/to/file.xlsx');

Convert to PDF

Convert CSV to PDF

$filePath = \SlickSpreadsheet::csvToPdf('/path/to/file.csv');

Convert XLSX to PDF

//FILE CAN BE .xls or .xlsx
$filePath = \SlickSpreadsheet::xlsToPdf('/path/to/file.xlsx');

itul / slick-spreadsheets

Maintainers

Details