Files
PhpSpreadsheet/samples/PivotTable/pvt03_PivotTable_Grouping.php
T
oleibman 9565757138 Reorganize Samples and Improve Downloader Class
A follow-on activity to PR #5061. That PR added scrollbars to the dropdown lists when samples were run in a browser. Earlier changes had broken up a number of categories into multiple entries because the dropdown lists were too long and wound up truncated. With the scrollbars, it makes sense to re-consolidate many of those lists, such as ComplexNumbers, which are all essentially the same test as each other. Some break-ups are retained (e.g. Basic/1/2/3/4/5) because they differ substantially from sample to sample; that's kind of an arbitrary decision, but it will have to do for now. I also renamed some of the members so that like members sort together when listing the directory (e.g. all pivot table samples now start with `pvt`). The sample code is mostly unchanged; only the directory and/or member names are changed.

The download samples were moved to their own new directory, and now represent a complete set of all the write formats that we permit. Studying their code, an improvement for `Helper\Downloader` became evident. It had been used merely to copy an existing file to be downloaded. However, by changing the first parameter of `download` to be either the name of the file directory (the existing usage) *or* a `Writer` object poised to issue `save`, you can use it to download your spreadsheet without having to worry about the headers which the browser requires. It then becomes generally useful beyond being used in samples:
```php
$writer = new WriterType($spreadsheet);
$downloader = new Downloader($writer, 'suggestedFileName.xlsx');
$downloader->download();
```
2026-10-22 13:22:48 -07:00

61 lines
2.1 KiB
PHP

<?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Worksheet\PivotTable\PivotField;
use PhpOffice\PhpSpreadsheet\Worksheet\PivotTable\PivotFieldGroup;
use PhpOffice\PhpSpreadsheet\Worksheet\PivotTable\PivotTableBuilder;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
$helper->log('Create new Spreadsheet object');
$spreadsheet = new Spreadsheet();
$spreadsheet->getProperties()->setTitle('PhpSpreadsheet PivotTable Grouping Sample');
$helper->log('Add source data');
$dataSheet = $spreadsheet->getActiveSheet();
$dataSheet->setTitle('Data');
$dataSheet->fromArray(
[
['Customer', 'Age', 'OrderDate', 'Amount'],
['Alice', 23, '2024-01-15', 100],
['Bob', 37, '2024-06-20', 150],
['Carol', 45, '2025-02-10', 200],
['Dan', 51, '2025-11-05', 250],
['Erin', 29, '2024-09-01', 175],
['Frank', 62, '2025-07-22', 300],
],
null,
'A1'
);
// --- Numeric range grouping: bucket Age into bands of 10 (20-30, 30-40, ...) ---
$helper->log('Build pivot table grouping Age into numeric ranges');
$agePivotSheet = $spreadsheet->createSheet();
$agePivotSheet->setTitle('ByAgeRange');
$ageBuilder = new PivotTableBuilder($dataSheet, 'A1:D7');
$ageBuilder
->groupFieldByNumericRange('Age', 10, 20, 70)
->addRowField('Age')
->addDataField('Amount', PivotField::SUBTOTAL_SUM);
$ageBuilder->build($agePivotSheet, 'A3', 'SalesByAgeRange');
// --- Date grouping: group OrderDate by quarter ---
$helper->log('Build pivot table grouping OrderDate by quarter');
$datePivotSheet = $spreadsheet->createSheet();
$datePivotSheet->setTitle('ByQuarter');
$dateBuilder = new PivotTableBuilder($dataSheet, 'A1:D7');
$dateBuilder
->groupFieldByDate('OrderDate', PivotFieldGroup::GROUP_BY_QUARTERS)
->addRowField('OrderDate')
->addDataField('Amount', PivotField::SUBTOTAL_SUM);
$dateBuilder->build($datePivotSheet, 'A3', 'SalesByQuarter');
$helper->log(
'Grouping is written into the pivot cache; the spreadsheet application '
. 'materialises the buckets when it refreshes the pivot on open.'
);
$helper->write($spreadsheet, __FILE__, ['Xlsx']);