SimpleXLSXGen

You can generate an Excel file containing multiple sheets using either the fluid interface or the classic interface.

Fluid Interface: Use addSheet($data, $sheetName) to append new sheets to the existing object.

Classic Interface: Instantiate new SimpleXLSXGen() and call addSheet($data, $sheetName) multiple times.

// Fluid interface
Shuchkin\SimpleXLSXGen::fromArray( $books, 'My books' )
    ->addSheet( $books2, 'Second Sheet' )
    ->download();

// Classic interface
use Shuchkin\SimpleXLSXGen;
$xlsx = new SimpleXLSXGen();
$xlsx->addSheet( $books, 'Catalog 2021' );
$xlsx->addSheet( $books2, 'Stephen King catalog');
$xlsx->downloadAs('books_2021.xlsx');

To export data to an Excel XLSX file, use the Shuchkin\SimpleXLSXGen::fromArray() method with a 2D array of data. You can then save the file, trigger a download, or cast the object to a string to get the raw XLSX content.

Supported output methods:

• saveAs('filename.xlsx'): Saves the file to the local filesystem.
• downloadAs('filename.xlsx'): Triggers a browser download.
• (string) $xlsx: Returns the raw XLSX content as a string.

$books = [
    ['ISBN', 'title', 'author', 'publisher', 'ctry' ],
    [618260307, 'The Hobbit', 'J. R. R. Tolkien', 'Houghton Mifflin', 'USA'],
    [908606664, 'Slinky Malinki', 'Lynley Dodd', 'Mallinson Rendel', 'NZ']
];
$xlsx = Shuchkin\SimpleXLSXGen::fromArray( $books );
$xlsx->saveAs('books.xlsx');

The recommended way to install SimpleXLSXGen is via Composer. This will install the latest supported version.

Alternatively, you can download the SimpleXLSXGen.php class file directly from the repository.

$ composer require shuchkin/simplexlsxgen

SimpleXLSXGen supports several types of hyperlinks:

• Automatic detection: Standard URLs (e.g., https://example.com) and email addresses (e.g., mailto:info@example.com) are automatically detected.
• HTML Anchor tags: Use <a href="URL">Anchor Text</a> for custom text.
• Internal links: Link to other sheets using <a href="'Sheet Name'!A1">Text</a>.
• Relative links: Link to other files using <a href="books.xlsx">Text</a>.

$xlsx = SimpleXLSXGen::fromArray([
    ['internal link', '<a href="\'My books 2\'!A1">Go to second sheet</a>'],
    ['http', 'https://example.com/'],
    ['mailto', 'info@example.com'],
])->addSheet([['Second sheet']], 'My books 2')->saveAs('hyperlinks.xlsx');

Use saveAs($filename) to write the generated Excel file to a specific path on your server. The filename is sanitized to remove null bytes, carriage returns, newlines, tabs, and double quotes.

If you want to use the default filename (which defaults to the workbook title or a timestamp), use save().

// Save to a specific filename
$xlsx->saveAs('reports/monthly_report.xlsx');

// Save using default name (Title or YmdHi.xlsx)
$xlsx->save();

To ensure dates and times are recognized correctly by Excel, use the SimpleXLSXGen::date2excel() static method. This converts date/time components into the floating-point number format used by Excel.

Signature: public static function date2excel($year, $month, $day, $hours = 0, $minutes = 0, $seconds = 0)

$excelDate = SimpleXLSXGen::date2excel(2023, 10, 25, 14, 30, 0);

Adjust the width of columns using setColWidth($col, $width). The $col parameter supports several formats:

• An integer (1-based index).
• A column letter (e.g., 'A', 'AA').
• A range of columns (e.g., 'A:C').

The $width parameter is an integer representing the width in characters.

$xlsx->setColWidth('A', 10);
$xlsx->setColWidth('B:D', 20);
$xlsx->setColWidth(5, 15);

To create a workbook with multiple sheets, instantiate the class and call addSheet() for each new sheet. Each call to addSheet() increments the sheet count and manages sheet naming automatically if a name is not provided.

addSheet() accepts:

• $rows: A 2D array of data for the sheet.
• $name: (Optional) A string for the sheet name (max 31 characters).

use Shuchkin\SimpleXLSXGen;

$xlsx = new SimpleXLSXGen();

// Add first sheet
$xlsx->addSheet([
    ['Data 1', 'Data 2'],
    ['Val 1', 'Val 2'],
], 'First Sheet');

// Add second sheet
$xlsx->addSheet([
    ['Info A', 'Info B'],
    ['X', 'Y'],
], 'Second Sheet');

You can create a new instance of SimpleXLSXGen using the create() static method or by instantiating the class directly. The create() method allows you to optionally set a title for the Excel file immediately.

By default, the generator uses 'Calibri' as the font with a size of 10.

use Shuchkin\SimpleXLSXGen;

// Option 1: Using create() with an optional title
$xlsx = SimpleXLSXGen::create('My Excel Report');

// Option 2: Standard instantiation
$xlsx = new SimpleXLSXGen();