Files
PhpSpreadsheet/samples/PivotTable/pvt01_Create_PivotTable.php
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

63 lines
2.0 KiB
PHP

<?php
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Worksheet\PivotTable\PivotField;
use PhpOffice\PhpSpreadsheet\Worksheet\PivotTable\PivotTableBuilder;
require __DIR__ . '/../Header.php';
/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
// Create new Spreadsheet object
$helper->log('Create new Spreadsheet object');
$spreadsheet = new Spreadsheet();
$spreadsheet->getProperties()
->setCreator('PhpSpreadsheet')
->setTitle('PhpSpreadsheet PivotTable Sample')
->setCategory('PivotTable');
// Fill a worksheet with the source data for the pivot table.
$helper->log('Add source data');
$dataSheet = $spreadsheet->getActiveSheet();
$dataSheet->setTitle('Data');
$dataSheet->fromArray(
[
['Region', 'Product', 'Quarter', 'Amount'],
['East', 'Widget', 'Q1', 100],
['East', 'Gadget', 'Q1', 200],
['West', 'Widget', 'Q1', 150],
['West', 'Gadget', 'Q1', 250],
['East', 'Widget', 'Q2', 120],
['East', 'Gadget', 'Q2', 220],
['West', 'Widget', 'Q2', 170],
['West', 'Gadget', 'Q2', 270],
],
null,
'A1'
);
// Create a worksheet to hold the pivot table.
$pivotSheet = $spreadsheet->createSheet();
$pivotSheet->setTitle('PivotTable');
// Build a pivot table:
// rows = Region
// columns = Product
// values = Sum of Amount
$helper->log('Build pivot table');
$builder = new PivotTableBuilder($dataSheet, 'A1:D9');
$builder
->addRowField('Region')
->addColumnField('Product')
->addDataField('Amount', PivotField::SUBTOTAL_SUM);
$pivotTable = $builder->build($pivotSheet, 'A3', 'SalesByRegion');
$helper->log('Pivot table "' . $pivotTable->getName() . '" created at ' . $pivotTable->getLocation());
$helper->log(
'The pivot table is written with refresh-on-load set, so the spreadsheet '
. 'application fills in the summarised values when the file is opened.'
);
// Pivot tables are an Xlsx feature.
$helper->write($spreadsheet, __FILE__, ['Xlsx']);