$sty
-html {
+body {
background-color: yellow;
}
@@ -703,16 +717,22 @@ echo $writer->generateSheetData();
echo $writer->generateHTMLFooter();
```
-#### Writing UTF-8 HTML files
+#### Editing HTML during save via a callback
-A HTML file can be marked as UTF-8 by writing a BOM file header. This
-can be enabled by using the following code:
+You can also add a callback function to edit the generated html
+before saving. For example, you could change the gridlines
+from a thin solid black line:
``` php
+function changeGridlines(string $html): string
+{
+ return str_replace('{border: 1px solid black;}',
+ '{border: 2px dashed red;}',
+ $html);
+}
$writer = new \PhpOffice\PhpSpreadsheet\Writer\Html($spreadsheet);
-$writer->setUseBOM(true);
-
-$writer->save("05featuredemo.htm");
+$writer->setEditHtmlCallback('changeGridlines');
+$writer->save($filename);
```
#### Decimal and thousands separators
@@ -751,7 +771,7 @@ own circumstances.
You can instantiate a writer with its specific name, like so:
-``` php
+```php
$writer = \PhpOffice\PhpSpreadsheet\IOFactory::createWriter($spreadsheet, 'Mpdf');
```
@@ -759,7 +779,7 @@ Or you can register which writer you are using with a more generic name,
so you don't need to remember which library you chose, only that you want
to write PDF files:
-``` php
+```php
$class = \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf::class;
\PhpOffice\PhpSpreadsheet\IOFactory::registerWriter('Pdf', $class);
$writer = \PhpOffice\PhpSpreadsheet\IOFactory::createWriter($spreadsheet, 'Pdf');
@@ -767,7 +787,7 @@ $writer = \PhpOffice\PhpSpreadsheet\IOFactory::createWriter($spreadsheet, 'Pdf')
Or you can instantiate directly the writer of your choice like so:
-``` php
+```php
$writer = \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf($spreadsheet);
```
@@ -776,7 +796,7 @@ $writer = \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf($spreadsheet);
If you need a custom implementation, or custom configuration, of a supported
PDF library. You can extends the PDF library, and the PDF writer like so:
-``` php
+```php
class My_Custom_TCPDF extends TCPDF
{
// ...
@@ -802,7 +822,7 @@ class My_Custom_TCPDF_Writer extends \PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf
Once you have identified the Renderer that you wish to use for PDF
generation, you can write a .pdf file using the following code:
-``` php
+```php
$writer = new \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf($spreadsheet);
$writer->save("05featuredemo.pdf");
```
@@ -815,7 +835,7 @@ first worksheet by default.
PDF files can contain one or more worksheets. If you want to write all
sheets into a single PDF file, use the following code:
-``` php
+```php
$writer->writeAllSheets();
```
@@ -824,7 +844,7 @@ $writer->writeAllSheets();
PDF files can contain one or more worksheets. Therefore, you can specify
which sheet to write to PDF:
-``` php
+```php
$writer->setSheetIndex(0);
```
@@ -834,13 +854,19 @@ By default, this writer pre-calculates all formulas in the spreadsheet.
This can be slow on large spreadsheets, and maybe even unwanted. You can
however disable formula pre-calculation:
-``` php
+```php
$writer = new \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf($spreadsheet);
$writer->setPreCalculateFormulas(false);
$writer->save("05featuredemo.pdf");
```
+#### Editing Pdf during save via a callback
+
+You can also add a callback function to edit the html used to
+generate the Pdf before saving.
+[See under Html](#editing-html-during-save-via-a-callback).
+
#### Decimal and thousands separators
See section `\PhpOffice\PhpSpreadsheet\Writer\Csv` how to control the
@@ -856,7 +882,7 @@ page setup properties, headers etc.
Here is an example how to open a template file, fill in a couple of
fields and save it again:
-``` php
+```php
$spreadsheet = \PhpOffice\PhpSpreadsheet\IOFactory::load('template.xlsx');
$worksheet = $spreadsheet->getActiveSheet();
diff --git a/docs/topics/reading-files.md b/docs/topics/reading-files.md
index 779082dc..1451f2ab 100644
--- a/docs/topics/reading-files.md
+++ b/docs/topics/reading-files.md
@@ -22,7 +22,7 @@ The simplest way to load a workbook file is to let PhpSpreadsheet's IO
Factory identify the file type and load it, calling the static `load()`
method of the `\PhpOffice\PhpSpreadsheet\IOFactory` class.
-``` php
+```php
$inputFileName = './sampleData/example1.xls';
/** Load $inputFileName to a Spreadsheet Object **/
@@ -59,7 +59,7 @@ supported filetype by name. However, you may get unpredictable results
if the file isn't of the right type (e.g. it is a CSV with an extension
of .xls), although this type of exception should normally be trapped.
-``` php
+```php
$inputFileName = './sampleData/example1.xls';
/** Create a new Xls Reader **/
@@ -81,7 +81,7 @@ Alternatively, you can use the IO Factory's `createReader()` method to
instantiate the reader object for you, simply telling it the file type
of the reader that you want instantiating.
-``` php
+```php
$inputFileType = 'Xls';
// $inputFileType = 'Xlsx';
// $inputFileType = 'Xml';
@@ -104,7 +104,7 @@ If you're uncertain of the filetype, you can use the `IOFactory::identify()`
method to identify the reader that you need, before using the
`createReader()` method to instantiate the reader object.
-``` php
+```php
$inputFileName = './sampleData/example1.xls';
/** Identify the type of $inputFileName **/
@@ -131,7 +131,7 @@ need any of the cell formatting information, then you can set the reader
to read only the data values and any formulae from each cell using the
`setReadDataOnly()` method.
-``` php
+```php
$inputFileType = 'Xls';
$inputFileName = './sampleData/example1.xls';
@@ -176,7 +176,7 @@ in reading.
To read a single sheet, you can pass that sheet name as a parameter to
the `setLoadSheetsOnly()` method.
-``` php
+```php
$inputFileType = 'Xls';
$inputFileName = './sampleData/example1.xls';
$sheetname = 'Data Sheet #2';
@@ -195,7 +195,7 @@ for a working example of this code.
If you want to read more than just a single sheet, you can pass a list
of sheet names as an array parameter to the `setLoadSheetsOnly()` method.
-``` php
+```php
$inputFileType = 'Xls';
$inputFileName = './sampleData/example1.xls';
$sheetnames = ['Data Sheet #1','Data Sheet #3'];
@@ -214,7 +214,7 @@ for a working example of this code.
To reset this option to the default, you can call the `setLoadAllSheets()`
method.
-``` php
+```php
$inputFileType = 'Xls';
$inputFileName = './sampleData/example1.xls';
@@ -248,7 +248,7 @@ should be read by the loader. A read filter must implement the
whether a workbook cell identified by those arguments should be read or
not.
-``` php
+```php
$inputFileType = 'Xls';
$inputFileName = './sampleData/example1.xls';
$sheetname = 'Data Sheet #3';
@@ -286,7 +286,7 @@ a very specific circumstance (when you only want cells in the range
A1:E7 from your worksheet. A generic Read Filter would probably be more
useful:
-``` php
+```php
/** Define a Read Filter class implementing \PhpOffice\PhpSpreadsheet\Reader\IReadFilter */
class MyReadFilter implements \PhpOffice\PhpSpreadsheet\Reader\IReadFilter
{
@@ -324,7 +324,7 @@ to read and process a large workbook in "chunks": an example of this
usage might be when transferring data from an Excel worksheet to a
database.
-``` php
+```php
$inputFileType = 'Xls';
$inputFileName = './sampleData/example2.xls';
@@ -393,7 +393,7 @@ the `setSheetIndex()` method of the `$reader`, then use the
`loadIntoExisting()` method rather than the `load()` method to actually read
the file into that worksheet.
-``` php
+```php
$inputFileType = 'Csv';
$inputFileNames = [
'./sampleData/example1.csv',
@@ -452,7 +452,7 @@ Class that we defined in [the above section](#reading-only-specific-columns-and-
and the `setSheetIndex()` method of the `$reader`, we can split the CSV
file across several individual worksheets.
-``` php
+```php
$inputFileType = 'Csv';
$inputFileName = './sampleData/example2.csv';
@@ -523,7 +523,7 @@ cannot auto-detect, it will default to the comma. If this does not fit your
use-case, you can manually specify a separator by using the `setDelimiter()`
method.
-``` php
+```php
$inputFileType = 'Csv';
$inputFileName = './sampleData/example1.tsv';
@@ -585,7 +585,7 @@ it encountered a hyperlink, or HTML markup within a CSV file.
So using a Value Binder allows a great deal more flexibility in the
loader logic when reading unformatted text files.
-``` php
+```php
/** Tell PhpSpreadsheet that we want to use the Advanced Value Binder **/
\PhpOffice\PhpSpreadsheet\Cell\Cell::setValueBinder( new \PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder() );
@@ -619,7 +619,7 @@ manner.
The PhpSpreadsheet Readers throw a
`\PhpOffice\PhpSpreadsheet\Reader\Exception`.
-``` php
+```php
$inputFileName = './sampleData/example-1.xls';
try {
@@ -646,7 +646,7 @@ whole file.
The `listWorksheetNames()` method returns a simple array listing each
worksheet name within the workbook:
-``` php
+```php
$reader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
$worksheetNames = $reader->listWorksheetNames($inputFileName);
@@ -667,7 +667,7 @@ for a working example of this code.
The `listWorksheetInfo()` method returns a nested array, with each entry
listing the name and dimensions for a worksheet:
-``` php
+```php
$reader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
$worksheetData = $reader->listWorksheetInfo($inputFileName);
diff --git a/docs/topics/recipes.md b/docs/topics/recipes.md
index b0956b6e..db09642d 100644
--- a/docs/topics/recipes.md
+++ b/docs/topics/recipes.md
@@ -20,7 +20,7 @@ metadata to search for a specific document in its document lists.
Setting spreadsheet metadata is done as follows:
-``` php
+```php
$spreadsheet->getProperties()
->setCreator("Maarten Balliauw")
->setLastModifiedBy("Maarten Balliauw")
@@ -38,13 +38,13 @@ $spreadsheet->getProperties()
The following line of code sets the active sheet index to the first
sheet:
-``` php
+```php
$spreadsheet->setActiveSheetIndex(0);
```
You can also set the active sheet by its name/title
-``` php
+```php
$spreadsheet->setActiveSheetIndexByName('DataSheet')
```
@@ -68,7 +68,7 @@ UST.
Writing a date value in a cell consists of 2 lines of code. Select the
method that suits you the best. Here are some examples:
-``` php
+```php
// MySQL-like timestamp '2008-12-31' or date string
\PhpOffice\PhpSpreadsheet\Cell\Cell::setValueBinder( new \PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder() );
@@ -136,14 +136,14 @@ The following line of code writes the formula
formula must start with `=` to make PhpSpreadsheet recognise this as a
formula.
-``` php
+```php
$spreadsheet->getActiveSheet()->setCellValue('B8','=IF(C4>500,"profit","loss")');
```
If you want to write a string beginning with an `=` character to a
cell, then you should use the `setCellValueExplicit()` method.
-``` php
+```php
$spreadsheet->getActiveSheet()
->setCellValueExplicit(
'B8',
@@ -154,14 +154,14 @@ $spreadsheet->getActiveSheet()
A cell's formula can be read again using the following line of code:
-``` php
+```php
$formula = $spreadsheet->getActiveSheet()->getCell('B8')->getValue();
```
If you need the calculated value of a cell, use the following code. This
is further explained in [the calculation engine](./calculation-engine.md).
-``` php
+```php
$value = $spreadsheet->getActiveSheet()->getCell('B8')->getCalculatedValue();
```
@@ -171,7 +171,7 @@ Some localisation elements have been included in PhpSpreadsheet. You can
set a locale by changing the settings. To set the locale to Russian you
would use:
-``` php
+```php
$locale = 'ru';
$validLocale = \PhpOffice\PhpSpreadsheet\Settings::setLocale($locale);
if (!$validLocale) {
@@ -185,7 +185,7 @@ will return an error, and English settings will be used throughout.
Once you have set a locale, you can translate a formula from its
internal English coding.
-``` php
+```php
$formula = $spreadsheet->getActiveSheet()->getCell('B8')->getValue();
$translatedFormula = \PhpOffice\PhpSpreadsheet\Calculation\Calculation::getInstance()->_translateFormulaToLocale($formula);
```
@@ -194,7 +194,7 @@ You can also create a formula using the function names and argument
separators appropriate to the defined locale; then translate it to
English before setting the cell value:
-``` php
+```php
$formula = '=ДÐЕЙ360(ДÐТÐ(2010;2;5);ДÐТÐ(2010;12;31);ИСТИÐÐ)';
$internalFormula = \PhpOffice\PhpSpreadsheet\Calculation\Calculation::getInstance()->translateFormulaToEnglish($formula);
$spreadsheet->getActiveSheet()->setCellValue('B8',$internalFormula);
@@ -232,7 +232,7 @@ the cell.
Here is how to achieve this in PhpSpreadsheet:
-``` php
+```php
$spreadsheet->getActiveSheet()->getCell('A1')->setValue("hello\nworld");
$spreadsheet->getActiveSheet()->getStyle('A1')->getAlignment()->setWrapText(true);
```
@@ -247,7 +247,7 @@ AdvancedValuebinder.php automatically turns on "wrap text" for the cell
when it sees a newline character in a string that you are inserting in a
cell. Just like Microsoft Office Excel. Try this:
-``` php
+```php
\PhpOffice\PhpSpreadsheet\Cell\Cell::setValueBinder( new \PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder() );
$spreadsheet->getActiveSheet()->getCell('A1')->setValue("hello\nworld");
@@ -261,7 +261,7 @@ You can set a cell's datatype explicitly by using the cell's
setValueExplicit method, or the setCellValueExplicit method of a
worksheet. Here's an example:
-``` php
+```php
$spreadsheet->getActiveSheet()->getCell('A1')
->setValueExplicit(
'25',
@@ -273,7 +273,7 @@ $spreadsheet->getActiveSheet()->getCell('A1')
You can make a cell a clickable URL by setting its hyperlink property:
-``` php
+```php
$spreadsheet->getActiveSheet()->setCellValue('E26', 'www.phpexcel.net');
$spreadsheet->getActiveSheet()->getCell('E26')->getHyperlink()->setUrl('https://www.example.com');
```
@@ -281,7 +281,7 @@ $spreadsheet->getActiveSheet()->getCell('E26')->getHyperlink()->setUrl('https://
If you want to make a hyperlink to another worksheet/cell, use the
following code:
-``` php
+```php
$spreadsheet->getActiveSheet()->setCellValue('E26', 'www.phpexcel.net');
$spreadsheet->getActiveSheet()->getCell('E26')->getHyperlink()->setUrl("sheet://'Sheetname'!A1");
```
@@ -293,7 +293,7 @@ $spreadsheet->getActiveSheet()->getCell('E26')->getHyperlink()->setUrl("sheet://
Setting a worksheet's page orientation and size can be done using the
following lines of code:
-``` php
+```php
$spreadsheet->getActiveSheet()->getPageSetup()
->setOrientation(\PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::ORIENTATION_LANDSCAPE);
$spreadsheet->getActiveSheet()->getPageSetup()
@@ -324,7 +324,7 @@ setFitToHeight(...) | 1 | setFitToPage(TRUE) | value 0 mean
Here is how to fit to 1 page wide by infinite pages tall:
-``` php
+```php
$spreadsheet->getActiveSheet()->getPageSetup()->setFitToWidth(1);
$spreadsheet->getActiveSheet()->getPageSetup()->setFitToHeight(0);
```
@@ -340,7 +340,7 @@ the initial values.
To set page margins for a worksheet, use this code:
-``` php
+```php
$spreadsheet->getActiveSheet()->getPageMargins()->setTop(1);
$spreadsheet->getActiveSheet()->getPageMargins()->setRight(0.75);
$spreadsheet->getActiveSheet()->getPageMargins()->setLeft(0.75);
@@ -356,7 +356,7 @@ Note that the margin values are specified in inches.
To center a page horizontally/vertically, you can use the following
code:
-``` php
+```php
$spreadsheet->getActiveSheet()->getPageSetup()->setHorizontalCentered(true);
$spreadsheet->getActiveSheet()->getPageSetup()->setVerticalCentered(false);
```
@@ -366,7 +366,7 @@ $spreadsheet->getActiveSheet()->getPageSetup()->setVerticalCentered(false);
Setting a worksheet's print header and footer can be done using the
following lines of code:
-``` php
+```php
$spreadsheet->getActiveSheet()->getHeaderFooter()
->setOddHeader('&C&HPlease treat this document as confidential!');
$spreadsheet->getActiveSheet()->getHeaderFooter()
@@ -460,13 +460,13 @@ $spreadsheet->getActiveSheet()->getHeaderFooter()->addImage($drawing, \PhpOffice
To set a print break, use the following code, which sets a row break on
row 10.
-``` php
+```php
$spreadsheet->getActiveSheet()->setBreak('A10', \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet::BREAK_ROW);
```
The following line of code sets a print break on column D:
-``` php
+```php
$spreadsheet->getActiveSheet()->setBreak('D10', \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet::BREAK_COLUMN);
```
@@ -484,7 +484,7 @@ PhpSpreadsheet can repeat specific rows/cells at top/left of a page. The
following code is an example of how to repeat row 1 to 5 on each printed
page of a specific worksheet:
-``` php
+```php
$spreadsheet->getActiveSheet()->getPageSetup()->setRowsToRepeatAtTopByStartAndEnd(1, 5);
```
@@ -492,13 +492,13 @@ $spreadsheet->getActiveSheet()->getPageSetup()->setRowsToRepeatAtTopByStartAndEn
To specify a worksheet's printing area, use the following code:
-``` php
+```php
$spreadsheet->getActiveSheet()->getPageSetup()->setPrintArea('A1:E5');
```
There can also be multiple printing areas in a single worksheet:
-``` php
+```php
$spreadsheet->getActiveSheet()->getPageSetup()->setPrintArea('A1:E5,G4:M20');
```
@@ -511,7 +511,7 @@ For example, one can set the foreground colour of a cell to red, aligned
to the right, and the border to black and thick border style. Let's do
that on cell B2:
-``` php
+```php
$spreadsheet->getActiveSheet()->getStyle('B2')
->getFont()->getColor()->setARGB(\PhpOffice\PhpSpreadsheet\Style\Color::COLOR_RED);
$spreadsheet->getActiveSheet()->getStyle('B2')
@@ -533,7 +533,7 @@ $spreadsheet->getActiveSheet()->getStyle('B2')
`getStyle()` also accepts a cell range as a parameter. For example, you
can set a red background color on a range of cells:
-``` php
+```php
$spreadsheet->getActiveSheet()->getStyle('B3:B7')->getFill()
->setFillType(\PhpOffice\PhpSpreadsheet\Style\Fill::FILL_SOLID)
->getStartColor()->setARGB('FFFF0000');
@@ -548,7 +548,7 @@ There is also an alternative manner to set styles. The following code
sets a cell's style to font bold, alignment right, top border thin and a
gradient fill:
-``` php
+```php
$styleArray = [
'font' => [
'bold' => true,
@@ -578,7 +578,7 @@ $spreadsheet->getActiveSheet()->getStyle('A3')->applyFromArray($styleArray);
Or with a range of cells:
-``` php
+```php
$spreadsheet->getActiveSheet()->getStyle('B3:B7')->applyFromArray($styleArray);
```
@@ -587,6 +587,13 @@ execution whenever you are setting more than one style property. But the
difference may barely be measurable unless you have many different
styles in your workbook.
+You can perform the opposite function, exporting a Style as an array,
+as follows:
+
+``` php
+$styleArray = $spreadsheet->getActiveSheet()->getStyle('A3')->exportArray();
+```
+
### Number formats
You often want to format numbers in Excel. For example you may want a
@@ -602,7 +609,7 @@ number format code unless you need a custom number format.
In PhpSpreadsheet, you can also apply various predefined number formats.
Example:
-``` php
+```php
$spreadsheet->getActiveSheet()->getStyle('A1')->getNumberFormat()
->setFormatCode(\PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_NUMBER_COMMA_SEPARATED1);
```
@@ -614,7 +621,7 @@ up as 1.587,20)
You can achieve exactly the same as the above by using this:
-``` php
+```php
$spreadsheet->getActiveSheet()->getStyle('A1')->getNumberFormat()
->setFormatCode('#,##0.00');
```
@@ -623,7 +630,7 @@ In Microsoft Office Excel, as well as in PhpSpreadsheet, you will have
to interact with raw number format codes whenever you need some special
custom number format. Example:
-``` php
+```php
$spreadsheet->getActiveSheet()->getStyle('A1')->getNumberFormat()
->setFormatCode('[Blue][>=3000]$#,##0;[Red][<0]$#,##0;$#,##0');
```
@@ -631,7 +638,7 @@ $spreadsheet->getActiveSheet()->getStyle('A1')->getNumberFormat()
Another example is when you want numbers zero-padded with leading zeros
to a fixed length:
-``` php
+```php
$spreadsheet->getActiveSheet()->getCell('A1')->setValue(19);
$spreadsheet->getActiveSheet()->getStyle('A1')->getNumberFormat()
->setFormatCode('0000'); // will show as 0019 in Excel
@@ -646,7 +653,7 @@ The readers shipped with PhpSpreadsheet come to the rescue. Load your
template workbook using e.g. Xlsx reader to reveal the number format
code. Example how read a number format code for cell A1:
-``` php
+```php
$reader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader('Xlsx');
$spreadsheet = $reader->load('template.xlsx');
var_dump($spreadsheet->getActiveSheet()->getStyle('A1')->getNumberFormat()->getFormatCode());
@@ -661,14 +668,14 @@ code in *xl/styles.xml*.
Let's set vertical alignment to the top for cells A1:D4
-``` php
+```php
$spreadsheet->getActiveSheet()->getStyle('A1:D4')
->getAlignment()->setVertical(\PhpOffice\PhpSpreadsheet\Style\Alignment::VERTICAL_TOP);
```
Here is how to achieve wrap text:
-``` php
+```php
$spreadsheet->getActiveSheet()->getStyle('A1:D4')
->getAlignment()->setWrapText(true);
```
@@ -678,7 +685,7 @@ $spreadsheet->getActiveSheet()->getStyle('A1:D4')
It is possible to set the default style of a workbook. Let's set the
default font to Arial size 8:
-``` php
+```php
$spreadsheet->getDefaultStyle()->getFont()->setName('Arial');
$spreadsheet->getDefaultStyle()->getFont()->setSize(8);
```
@@ -689,7 +696,7 @@ In PhpSpreadsheet it is easy to apply various borders on a rectangular
selection. Here is how to apply a thick red border outline around cells
B2:G8.
-``` php
+```php
$styleArray = [
'borders' => [
'outline' => [
@@ -753,69 +760,74 @@ another style array.
Array key | Maps to property
-------------|-------------------
-fill | getFill()
-font | getFont()
-borders | getBorders()
-alignment | getAlignment()
-numberFormat | getNumberFormat()
-protection | getProtection()
-
-**\PhpOffice\PhpSpreadsheet\Style\Fill**
-
-Array key | Maps to property
------------|-------------------
-fillType | setFillType()
-rotation | setRotation()
-startColor | getStartColor()
-endColor | getEndColor()
-color | getStartColor()
-
-**\PhpOffice\PhpSpreadsheet\Style\Font**
-
-Array key | Maps to property
-------------|-------------------
-name | setName()
-bold | setBold()
-italic | setItalic()
-underline | setUnderline()
-strikethrough | setStrikethrough()
-color | getColor()
-size | setSize()
-superscript | setSuperscript()
-subscript | setSubscript()
-
-**\PhpOffice\PhpSpreadsheet\Style\Borders**
-
-Array key | Maps to property
-------------------|-------------------
-allBorders | getLeft(); getRight(); getTop(); getBottom()
-left | getLeft()
-right | getRight()
-top | getTop()
-bottom | getBottom()
-diagonal | getDiagonal()
-vertical | getVertical()
-horizontal | getHorizontal()
-diagonalDirection | setDiagonalDirection()
-outline | setOutline()
-
-**\PhpOffice\PhpSpreadsheet\Style\Border**
-
-Array key | Maps to property
-------------|-------------------
-borderStyle | setBorderStyle()
-color | getColor()
+alignment | setAlignment()
+borders | setBorders()
+fill | setFill()
+font | setFont()
+numberFormat | setNumberFormat()
+protection | setProtection()
+quotePrefix | setQuotePrefix()
**\PhpOffice\PhpSpreadsheet\Style\Alignment**
Array key | Maps to property
------------|-------------------
horizontal | setHorizontal()
-vertical | setVertical()
-textRotation| setTextRotation()
-wrapText | setWrapText()
-shrinkToFit | setShrinkToFit()
indent | setIndent()
+readOrder | setReadOrder()
+shrinkToFit | setShrinkToFit()
+textRotation| setTextRotation()
+vertical | setVertical()
+wrapText | setWrapText()
+
+**\PhpOffice\PhpSpreadsheet\Style\Border**
+
+Array key | Maps to property
+------------|-------------------
+borderStyle | setBorderStyle()
+color | setColor()
+
+**\PhpOffice\PhpSpreadsheet\Style\Borders**
+
+Array key | Maps to property
+------------------|-------------------
+allBorders | setLeft(); setRight(); setTop(); setBottom()
+bottom | setBottom()
+diagonal | setDiagonal()
+diagonalDirection | setDiagonalDirection()
+left | setLeft()
+right | setRight()
+top | setTop()
+
+**\PhpOffice\PhpSpreadsheet\Style\Color**
+
+Array key | Maps to property
+------------|-------------------
+argb | setARGB()
+
+**\PhpOffice\PhpSpreadsheet\Style\Fill**
+
+Array key | Maps to property
+-----------|-------------------
+color | getStartColor()
+endColor | getEndColor()
+fillType | setFillType()
+rotation | setRotation()
+startColor | getStartColor()
+
+**\PhpOffice\PhpSpreadsheet\Style\Font**
+
+Array key | Maps to property
+------------|-------------------
+bold | setBold()
+color | getColor()
+italic | setItalic()
+name | setName()
+size | setSize()
+strikethrough | setStrikethrough()
+subscript | setSubscript()
+superscript | setSuperscript()
+underline | setUnderline()
**\PhpOffice\PhpSpreadsheet\Style\NumberFormat**
@@ -839,7 +851,7 @@ is below zero, and to green if its value is zero or more.
One can set a conditional style ruleset to a cell using the following
code:
-``` php
+```php
$conditional1 = new \PhpOffice\PhpSpreadsheet\Style\Conditional();
$conditional1->setConditionType(\PhpOffice\PhpSpreadsheet\Style\Conditional::CONDITION_CELLIS);
$conditional1->setOperatorType(\PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_LESSTHAN);
@@ -864,7 +876,7 @@ $spreadsheet->getActiveSheet()->getStyle('B2')->setConditionalStyles($conditiona
If you want to copy the ruleset to other cells, you can duplicate the
style object:
-``` php
+```php
$spreadsheet->getActiveSheet()
->duplicateStyle(
$spreadsheet->getActiveSheet()->getStyle('B2'),
@@ -877,7 +889,7 @@ $spreadsheet->getActiveSheet()
To add a comment to a cell, use the following code. The example below
adds a comment to cell E11:
-``` php
+```php
$spreadsheet->getActiveSheet()
->getComment('E11')
->setAuthor('Mark Baker');
@@ -899,7 +911,7 @@ $spreadsheet->getActiveSheet()
To apply an autofilter to a range of cells, use the following code:
-``` php
+```php
$spreadsheet->getActiveSheet()->setAutoFilter('A1:C9');
```
@@ -919,45 +931,85 @@ disallow inserting rows on a specific sheet, disallow sorting, ...
- Cell: offers the option to lock/unlock a cell as well as show/hide
the internal formula.
+**Make sure you enable worksheet protection if you need any of the
+worksheet or cell protection features!** This can be done using the following
+code:
+
+```php
+$spreadsheet->getActiveSheet()->getProtection()->setSheet(true);
+```
+
+### Document
+
An example on setting document security:
-``` php
-$spreadsheet->getSecurity()->setLockWindows(true);
-$spreadsheet->getSecurity()->setLockStructure(true);
-$spreadsheet->getSecurity()->setWorkbookPassword("PhpSpreadsheet");
+```php
+$security = $spreadsheet->getSecurity();
+$security->setLockWindows(true);
+$security->setLockStructure(true);
+$security->setWorkbookPassword("PhpSpreadsheet");
```
+### Worksheet
+
An example on setting worksheet security:
-``` php
-$spreadsheet->getActiveSheet()
- ->getProtection()->setPassword('PhpSpreadsheet');
-$spreadsheet->getActiveSheet()
- ->getProtection()->setSheet(true);
-$spreadsheet->getActiveSheet()
- ->getProtection()->setSort(true);
-$spreadsheet->getActiveSheet()
- ->getProtection()->setInsertRows(true);
-$spreadsheet->getActiveSheet()
- ->getProtection()->setFormatCells(true);
+```php
+$protection = $spreadsheet->getActiveSheet()->getProtection();
+$protection->setPassword('PhpSpreadsheet');
+$protection->setSheet(true);
+$protection->setSort(true);
+$protection->setInsertRows(true);
+$protection->setFormatCells(true);
```
+If writing Xlsx files you can specify the algorithm used to hash the password
+before calling `setPassword()` like so:
+
+```php
+$protection = $spreadsheet->getActiveSheet()->getProtection();
+$protection->setAlgorithm(Protection::ALGORITHM_SHA_512);
+$protection->setSpinCount(20000);
+$protection->setPassword('PhpSpreadsheet');
+```
+
+The salt should **not** be set manually and will be automatically generated
+when setting a new password.
+
+### Cell
+
An example on setting cell security:
-``` php
+```php
$spreadsheet->getActiveSheet()->getStyle('B1')
->getProtection()
->setLocked(\PhpOffice\PhpSpreadsheet\Style\Protection::PROTECTION_UNPROTECTED);
```
-**Make sure you enable worksheet protection if you need any of the
-worksheet protection features!** This can be done using the following
-code:
+## Reading protected spreadsheet
-``` php
-$spreadsheet->getActiveSheet()->getProtection()->setSheet(true);
+Spreadsheets that are protected as described above can always be read by
+PhpSpreadsheet. There is no need to know the password or do anything special in
+order to read a protected file.
+
+However if you need to implement a password verification mechanism, you can use the
+following helper method:
+
+
+```php
+$protection = $spreadsheet->getActiveSheet()->getProtection();
+$allowed = $protection->verify('my password');
+
+if ($allowed) {
+ doSomething();
+} else {
+ throw new Exception('Incorrect password');
+}
```
+If you need to completely prevent reading a file by any tool, including PhpSpreadsheet,
+then you are looking for "encryption", not "protection".
+
## Setting data validation on a cell
Data validation is a powerful feature of Xlsx. It allows to specify an
@@ -968,7 +1020,7 @@ filter can be a range (i.e. value must be between 0 and 10), a list
The following piece of code only allows numbers between 10 and 20 to be
entered in cell B3:
-``` php
+```php
$validation = $spreadsheet->getActiveSheet()->getCell('B3')
->getDataValidation();
$validation->setType( \PhpOffice\PhpSpreadsheet\Cell\DataValidation::TYPE_WHOLE );
@@ -987,7 +1039,7 @@ $validation->setFormula2(20);
The following piece of code only allows an item picked from a list of
data to be entered in cell B5:
-``` php
+```php
$validation = $spreadsheet->getActiveSheet()->getCell('B5')
->getDataValidation();
$validation->setType( \PhpOffice\PhpSpreadsheet\Cell\DataValidation::TYPE_LIST );
@@ -1017,7 +1069,7 @@ the item values themselves can contain the comma `,` character itself.
If you need data validation on multiple cells, one can clone the
ruleset:
-``` php
+```php
$spreadsheet->getActiveSheet()->getCell('B8')->setDataValidation(clone $validation);
```
@@ -1025,7 +1077,7 @@ $spreadsheet->getActiveSheet()->getCell('B8')->setDataValidation(clone $validati
A column's width can be set using the following code:
-``` php
+```php
$spreadsheet->getActiveSheet()->getColumnDimension('D')->setWidth(12);
```
@@ -1033,7 +1085,7 @@ If you want PhpSpreadsheet to perform an automatic width calculation,
use the following code. PhpSpreadsheet will approximate the column with
to the width of the widest column value.
-``` php
+```php
$spreadsheet->getActiveSheet()->getColumnDimension('B')->setAutoSize(true);
```
@@ -1070,7 +1122,7 @@ To set a worksheet's column visibility, you can use the following code.
The first line explicitly shows the column C, the second line hides
column D.
-``` php
+```php
$spreadsheet->getActiveSheet()->getColumnDimension('C')->setVisible(true);
$spreadsheet->getActiveSheet()->getColumnDimension('D')->setVisible(false);
```
@@ -1079,7 +1131,7 @@ $spreadsheet->getActiveSheet()->getColumnDimension('D')->setVisible(false);
To group/outline a column, you can use the following code:
-``` php
+```php
$spreadsheet->getActiveSheet()->getColumnDimension('E')->setOutlineLevel(1);
```
@@ -1087,7 +1139,7 @@ You can also collapse the column. Note that you should also set the
column invisible, otherwise the collapse will not be visible in Excel
2007.
-``` php
+```php
$spreadsheet->getActiveSheet()->getColumnDimension('E')->setCollapsed(true);
$spreadsheet->getActiveSheet()->getColumnDimension('E')->setVisible(false);
```
@@ -1098,7 +1150,7 @@ on collapsing.
You can instruct PhpSpreadsheet to add a summary to the right (default),
or to the left. The following code adds the summary to the left:
-``` php
+```php
$spreadsheet->getActiveSheet()->setShowSummaryRight(false);
```
@@ -1106,7 +1158,7 @@ $spreadsheet->getActiveSheet()->setShowSummaryRight(false);
A row's height can be set using the following code:
-``` php
+```php
$spreadsheet->getActiveSheet()->getRowDimension('10')->setRowHeight(100);
```
@@ -1119,7 +1171,7 @@ of values is between 0 and 409 pts, where 0 pts is a hidden row.
To set a worksheet''s row visibility, you can use the following code.
The following example hides row number 10.
-``` php
+```php
$spreadsheet->getActiveSheet()->getRowDimension('10')->setVisible(false);
```
@@ -1131,21 +1183,21 @@ AutoFilter range if you save the file.
To group/outline a row, you can use the following code:
-``` php
+```php
$spreadsheet->getActiveSheet()->getRowDimension('5')->setOutlineLevel(1);
```
You can also collapse the row. Note that you should also set the row
invisible, otherwise the collapse will not be visible in Excel 2007.
-``` php
+```php
$spreadsheet->getActiveSheet()->getRowDimension('5')->setCollapsed(true);
$spreadsheet->getActiveSheet()->getRowDimension('5')->setVisible(false);
```
Here's an example which collapses rows 50 to 80:
-``` php
+```php
for ($i = 51; $i <= 80; $i++) {
$spreadsheet->getActiveSheet()->setCellValue('A' . $i, "FName $i");
$spreadsheet->getActiveSheet()->setCellValue('B' . $i, "LName $i");
@@ -1162,7 +1214,7 @@ $spreadsheet->getActiveSheet()->getRowDimension(81)->setCollapsed(true);
You can instruct PhpSpreadsheet to add a summary below the collapsible
rows (default), or above. The following code adds the summary above:
-``` php
+```php
$spreadsheet->getActiveSheet()->setShowSummaryBelow(false);
```
@@ -1172,13 +1224,13 @@ If you have a big piece of data you want to display in a worksheet, you
can merge two or more cells together, to become one cell. This can be
done using the following code:
-``` php
+```php
$spreadsheet->getActiveSheet()->mergeCells('A18:E22');
```
Removing a merge can be done using the unmergeCells method:
-``` php
+```php
$spreadsheet->getActiveSheet()->unmergeCells('A18:E22');
```
@@ -1187,7 +1239,7 @@ $spreadsheet->getActiveSheet()->unmergeCells('A18:E22');
You can insert/remove rows/columns at a specific position. The following
code inserts 2 new rows, right before row 7:
-``` php
+```php
$spreadsheet->getActiveSheet()->insertNewRowBefore(7, 2);
```
@@ -1198,7 +1250,7 @@ to a worksheet. Therefore, you must first instantiate a new
`\PhpOffice\PhpSpreadsheet\Worksheet\Drawing`, and assign its properties a
meaningful value:
-``` php
+```php
$drawing = new \PhpOffice\PhpSpreadsheet\Worksheet\Drawing();
$drawing->setName('Logo');
$drawing->setDescription('Logo');
@@ -1210,13 +1262,13 @@ To add the above drawing to the worksheet, use the following snippet of
code. PhpSpreadsheet creates the link between the drawing and the
worksheet:
-``` php
+```php
$drawing->setWorksheet($spreadsheet->getActiveSheet());
```
You can set numerous properties on a drawing, here are some examples:
-``` php
+```php
$drawing->setName('Paid');
$drawing->setDescription('Paid');
$drawing->setPath('./images/paid.png');
@@ -1230,7 +1282,7 @@ $drawing->getShadow()->setDirection(45);
You can also add images created using GD functions without needing to
save them to disk first as In-Memory drawings.
-``` php
+```php
// Use GD to create an in-memory image
$gdImage = @imagecreatetruecolor(120, 20) or die('Cannot Initialize new GD image stream');
$textColor = imagecolorallocate($gdImage, 255, 255, 255);
@@ -1258,7 +1310,7 @@ that has been loaded, and save them as individual image files to disk.
The following code extracts images from the current active worksheet,
and writes each as a separate file.
-``` php
+```php
$i = 0;
foreach ($spreadsheet->getActiveSheet()->getDrawingCollection() as $drawing) {
if ($drawing instanceof \PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing) {
@@ -1303,7 +1355,7 @@ creates the following rich text string:
> This invoice is ***payable within thirty days after the end of the
> month*** unless specified otherwise on the invoice.
-``` php
+```php
$richText = new \PhpOffice\PhpSpreadsheet\RichText\RichText();
$richText->createText('This invoice is ');
$payable = $richText->createTextRun('payable within thirty days after the end of the month');
@@ -1319,7 +1371,7 @@ $spreadsheet->getActiveSheet()->getCell('A18')->setValue($richText);
PhpSpreadsheet supports the definition of named ranges. These can be
defined using the following code:
-``` php
+```php
// Add some data
$spreadsheet->setActiveSheetIndex(0);
$spreadsheet->getActiveSheet()->setCellValue('A1', 'Firstname:');
@@ -1328,14 +1380,73 @@ $spreadsheet->getActiveSheet()->setCellValue('B1', 'Maarten');
$spreadsheet->getActiveSheet()->setCellValue('B2', 'Balliauw');
// Define named ranges
-$spreadsheet->addNamedRange( new \PhpOffice\PhpSpreadsheet\NamedRange('PersonFN', $spreadsheet->getActiveSheet(), 'B1') );
-$spreadsheet->addNamedRange( new \PhpOffice\PhpSpreadsheet\NamedRange('PersonLN', $spreadsheet->getActiveSheet(), 'B2') );
+$spreadsheet->addNamedRange( new \PhpOffice\PhpSpreadsheet\NamedRange('PersonFN', $spreadsheet->getActiveSheet(), '$B$1'));
+$spreadsheet->addNamedRange( new \PhpOffice\PhpSpreadsheet\NamedRange('PersonLN', $spreadsheet->getActiveSheet(), '$B$2'));
```
Optionally, a fourth parameter can be passed defining the named range
local (i.e. only usable on the current worksheet). Named ranges are
global by default.
+## Define a named formula
+
+In addition to named ranges, PhpSpreadsheet also supports the definition of named formulae. These can be
+defined using the following code:
+
+```php
+// Add some data
+$spreadsheet->setActiveSheetIndex(0);
+$worksheet = $spreadsheet->getActiveSheet();
+$worksheet
+ ->setCellValue('A1', 'Product')
+ ->setCellValue('B1', 'Quantity')
+ ->setCellValue('C1', 'Unit Price')
+ ->setCellValue('D1', 'Price')
+ ->setCellValue('E1', 'VAT')
+ ->setCellValue('F1', 'Total');
+
+// Define named formula
+$spreadsheet->addNamedFormula( new \PhpOffice\PhpSpreadsheet\NamedFormula('GERMAN_VAT_RATE', $worksheet, '=16.0%'));
+$spreadsheet->addNamedFormula( new \PhpOffice\PhpSpreadsheet\NamedFormula('CALCULATED_PRICE', $worksheet, '=$B1*$C1'));
+$spreadsheet->addNamedFormula( new \PhpOffice\PhpSpreadsheet\NamedFormula('GERMAN_VAT', $worksheet, '=$D1*GERMAN_VAT_RATE'));
+$spreadsheet->addNamedFormula( new \PhpOffice\PhpSpreadsheet\NamedFormula('TOTAL_INCLUDING_VAT', $worksheet, '=$D1+$E1'));
+
+$worksheet
+ ->setCellValue('A2', 'Advanced Web Application Architecture')
+ ->setCellValue('B2', 2)
+ ->setCellValue('C2', 23.0)
+ ->setCellValue('D2', '=CALCULATED_PRICE')
+ ->setCellValue('E2', '=GERMAN_VAT')
+ ->setCellValue('F2', '=TOTAL_INCLUDING_VAT');
+$spreadsheet->getActiveSheet()
+ ->setCellValue('A3', 'Object Design Style Guide')
+ ->setCellValue('B3', 5)
+ ->setCellValue('C3', 12.0)
+ ->setCellValue('D3', '=CALCULATED_PRICE')
+ ->setCellValue('E3', '=GERMAN_VAT')
+ ->setCellValue('F3', '=TOTAL_INCLUDING_VAT');
+$spreadsheet->getActiveSheet()
+ ->setCellValue('A4', 'PHP For the Web')
+ ->setCellValue('B4', 3)
+ ->setCellValue('C4', 10.0)
+ ->setCellValue('D4', '=CALCULATED_PRICE')
+ ->setCellValue('E4', '=GERMAN_VAT')
+ ->setCellValue('F4', '=TOTAL_INCLUDING_VAT');
+
+// Use a relative named range to provide the totals for rows 2-4
+$spreadsheet->addNamedRange( new \PhpOffice\PhpSpreadsheet\NamedRange('COLUMN_TOTAL', $worksheet, '=A$2:A$4') );
+
+$spreadsheet->getActiveSheet()
+ ->setCellValue('B6', '=SUBTOTAL(109,COLUMN_TOTAL)')
+ ->setCellValue('D6', '=SUBTOTAL(109,COLUMN_TOTAL)')
+ ->setCellValue('E6', '=SUBTOTAL(109,COLUMN_TOTAL)')
+ ->setCellValue('F6', '=SUBTOTAL(109,COLUMN_TOTAL)');
+```
+
+As with named ranges, an optional fourth parameter can be passed defining the named formula
+scope as local (i.e. only usable on the specified worksheet). Otherwise, named formulae are
+global by default.
+
## Redirect output to a client's web browser
Sometimes, one really wants to output a file to a client''s browser,
@@ -1362,7 +1473,7 @@ your document is needed, it is recommended not to use `php://output`.
Example of a script redirecting an Excel 2007 file to the client's
browser:
-``` php
+```php
/* Here there will be some code where you create $spreadsheet */
// redirect output to client browser
@@ -1376,7 +1487,7 @@ $writer->save('php://output');
Example of a script redirecting an Xls file to the client's browser:
-``` php
+```php
/* Here there will be some code where you create $spreadsheet */
// redirect output to client browser
@@ -1404,7 +1515,7 @@ at the client browser, and/or that headers cannot be set by PHP
Default column width can be set using the following code:
-``` php
+```php
$spreadsheet->getActiveSheet()->getDefaultColumnDimension()->setWidth(12);
```
@@ -1412,7 +1523,7 @@ $spreadsheet->getActiveSheet()->getDefaultColumnDimension()->setWidth(12);
Default row height can be set using the following code:
-``` php
+```php
$spreadsheet->getActiveSheet()->getDefaultRowDimension()->setRowHeight(15);
```
@@ -1425,7 +1536,7 @@ file to a temporary location.
Here''s an example which generates an image in memory and adds it to the
active worksheet:
-``` php
+```php
// Generate an image
$gdImage = @imagecreatetruecolor(120, 20) or die('Cannot Initialize new GD image stream');
$textColor = imagecolorallocate($gdImage, 255, 255, 255);
@@ -1446,7 +1557,7 @@ $drawing->setWorksheet($spreadsheet->getActiveSheet());
To set a worksheet's zoom level, the following code can be used:
-``` php
+```php
$spreadsheet->getActiveSheet()->getSheetView()->setZoomScale(75);
```
@@ -1457,7 +1568,7 @@ Note that zoom level should be in range 10 - 400.
Sometimes you want to set a color for sheet tab. For example you can
have a red sheet tab:
-``` php
+```php
$worksheet->getTabColor()->setRGB('FF0000');
```
@@ -1465,7 +1576,7 @@ $worksheet->getTabColor()->setRGB('FF0000');
If you need to create more worksheets in the workbook, here is how:
-``` php
+```php
$worksheet1 = $spreadsheet->createSheet();
$worksheet1->setTitle('Another sheet');
```
@@ -1478,7 +1589,7 @@ worksheets in the workbook.
Set a worksheet to be **hidden** using this code:
-``` php
+```php
$spreadsheet->getActiveSheet()
->setSheetState(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet::SHEETSTATE_HIDDEN);
```
@@ -1500,7 +1611,7 @@ Worksheets can be set individually whether column `A` should start at
left or right side. Default is left. Here is how to set columns from
right-to-left.
-``` php
+```php
// right-to-left worksheet
$spreadsheet->getActiveSheet()->setRightToLeft(true);
```
diff --git a/docs/topics/settings.md b/docs/topics/settings.md
index a9aae9f9..d28a9996 100644
--- a/docs/topics/settings.md
+++ b/docs/topics/settings.md
@@ -13,7 +13,7 @@ Read more about [memory saving](./memory_saving.md).
To enable cell caching, you must provide your own implementation of cache like so:
-``` php
+```php
$cache = new MyCustomPsr16Implementation();
\PhpOffice\PhpSpreadsheet\Settings::setCache($cache);
@@ -25,7 +25,7 @@ Some localisation elements have been included in PhpSpreadsheet. You can
set a locale by changing the settings. To set the locale to Brazilian
Portuguese you would use:
-``` php
+```php
$locale = 'pt_br';
$validLocale = \PhpOffice\PhpSpreadsheet\Settings::setLocale($locale);
if (!$validLocale) {
@@ -43,3 +43,20 @@ More details of the features available once a locale has been set,
including a list of the languages and locales currently supported, can
be found in [Locale Settings for
Formulae](./recipes.md#locale-settings-for-formulae).
+
+## HTTP client
+
+In order to use the `WEBSERVICE` function in formulae, you must configure an
+HTTP client. Assuming you chose Guzzle 7, this can be done like:
+
+
+```php
+use GuzzleHttp\Client;
+use Http\Factory\Guzzle\RequestFactory;
+use PhpOffice\PhpSpreadsheet\Settings;
+
+$client = new Client();
+$requestFactory = new RequestFactory();
+
+Settings::setHttpClient($client, $requestFactory);
+```
diff --git a/docs/topics/worksheets.md b/docs/topics/worksheets.md
index f97a0066..0199f13c 100644
--- a/docs/topics/worksheets.md
+++ b/docs/topics/worksheets.md
@@ -25,7 +25,7 @@ each worksheet "tab" is shown when the workbook is opened in MS Excel
(or other appropriate Spreadsheet program). To access a sheet by its
index, use the `getSheet()` method.
-``` php
+```php
// Get the second sheet in the workbook
// Note that sheets are indexed from 0
$spreadsheet->getSheet(1);
@@ -38,7 +38,7 @@ workbook.
To access a sheet by name, use the `getSheetByName()` method, specifying
the name of the worksheet that you want to access.
-``` php
+```php
// Retrieve the worksheet called 'Worksheet 1'
$spreadsheet->getSheetByName('Worksheet 1');
```
@@ -48,7 +48,7 @@ and you can access that directly. The currently active worksheet is the
one that will be active when the workbook is opened in MS Excel (or
other appropriate Spreadsheet program).
-``` php
+```php
// Retrieve the current active worksheet
$spreadsheet->getActiveSheet();
```
@@ -64,7 +64,7 @@ a new "last" sheet; but you can also specify an index position as an
argument, and the worksheet will be inserted at that position, shuffling
all subsequent worksheets in the collection down a place.
-``` php
+```php
$spreadsheet->createSheet();
```
@@ -76,7 +76,7 @@ Alternatively, you can instantiate a new worksheet (setting the title to
whatever you choose) and then insert it into your workbook using the
`addSheet()` method.
-``` php
+```php
// Create a new worksheet called "My Data"
$myWorkSheet = new \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet($spreadsheet, 'My Data');
@@ -93,7 +93,7 @@ Sheets within the same workbook can be copied by creating a clone of the
worksheet you wish to copy, and then using the `addSheet()` method to
insert the clone into the workbook.
-``` php
+```php
$clonedWorksheet = clone $spreadsheet->getSheetByName('Worksheet 1');
$clonedWorksheet->setTitle('Copy of Worksheet 1');
$spreadsheet->addSheet($clonedWorksheet);
@@ -117,7 +117,7 @@ duplicate name.
You can delete a worksheet from a workbook, identified by its index
position, using the `removeSheetByIndex()` method
-``` php
+```php
$sheetIndex = $spreadsheet->getIndex(
$spreadsheet->getSheetByName('Worksheet 1')
);
diff --git a/samples/Basic/13_Calculation.php b/samples/Basic/13_Calculation.php
index 087b443f..ed2e1dcc 100644
--- a/samples/Basic/13_Calculation.php
+++ b/samples/Basic/13_Calculation.php
@@ -157,8 +157,10 @@ $spreadsheet->getActiveSheet()->setCellValue('E23', 'Mode of both ranges:')
$helper->log('Calculated data');
for ($col = 'B'; $col != 'G'; ++$col) {
for ($row = 14; $row <= 41; ++$row) {
- if ((($formula = $spreadsheet->getActiveSheet()->getCell($col . $row)->getValue()) !== null) &&
- ($formula[0] == '=')) {
+ if (
+ (($formula = $spreadsheet->getActiveSheet()->getCell($col . $row)->getValue()) !== null) &&
+ ($formula[0] == '=')
+ ) {
$helper->log('Value of ' . $col . $row . ' [' . $formula . ']: ' . $spreadsheet->getActiveSheet()->getCell($col . $row)->getCalculatedValue());
}
}
diff --git a/samples/Basic/13_CalculationCyclicFormulae.php b/samples/Basic/13_CalculationCyclicFormulae.php
index a446e56e..b7c6a511 100644
--- a/samples/Basic/13_CalculationCyclicFormulae.php
+++ b/samples/Basic/13_CalculationCyclicFormulae.php
@@ -22,8 +22,10 @@ Calculation::getInstance($spreadsheet)->cyclicFormulaCount = 15;
$helper->log('Calculated data');
for ($row = 1; $row <= 2; ++$row) {
for ($col = 'A'; $col != 'C'; ++$col) {
- if ((($formula = $spreadsheet->getActiveSheet()->getCell($col . $row)->getValue()) !== null) &&
- ($formula[0] == '=')) {
+ if (
+ (($formula = $spreadsheet->getActiveSheet()->getCell($col . $row)->getValue()) !== null) &&
+ ($formula[0] == '=')
+ ) {
$helper->log('Value of ' . $col . $row . ' [' . $formula . ']: ' . $spreadsheet->getActiveSheet()->getCell($col . $row)->getCalculatedValue());
}
}
diff --git a/samples/Basic/17b_Html.php b/samples/Basic/17b_Html.php
new file mode 100644
index 00000000..97bb29a3
--- /dev/null
+++ b/samples/Basic/17b_Html.php
@@ -0,0 +1,20 @@
+getFilename(__FILE__, 'html');
+$writer = new Html($spreadsheet);
+
+function changeGridlines(string $html): string
+{
+ return str_replace('{border: 1px solid black;}', '{border: 2px dashed red;}', $html);
+}
+
+$callStartTime = microtime(true);
+$writer->setEmbedImages(true);
+$writer->setEditHtmlCallback('changeGridlines');
+$writer->save($filename);
+$helper->logWrite($writer, $filename, $callStartTime);
diff --git a/samples/Basic/20_Read_Excel2003XML.php b/samples/Basic/20_Read_Excel2003XML.php
index 44425e20..48ac3373 100644
--- a/samples/Basic/20_Read_Excel2003XML.php
+++ b/samples/Basic/20_Read_Excel2003XML.php
@@ -4,7 +4,7 @@ use PhpOffice\PhpSpreadsheet\IOFactory;
require __DIR__ . '/../Header.php';
-$filename = __DIR__ . '/../templates/Excel2003XMLTest.xml';
+$filename = __DIR__ . '/../templates/excel2003.xml';
$callStartTime = microtime(true);
$spreadsheet = IOFactory::load($filename);
$helper->logRead('Xml', $filename, $callStartTime);
diff --git a/samples/Basic/26_Utf8.php b/samples/Basic/26_Utf8.php
index 52a64509..52953251 100644
--- a/samples/Basic/26_Utf8.php
+++ b/samples/Basic/26_Utf8.php
@@ -12,10 +12,12 @@ $spreadsheet = $reader->load(__DIR__ . '/../templates/26template.xlsx');
// at this point, we could do some manipulations with the template, but we skip this step
$helper->write($spreadsheet, __FILE__, ['Xlsx', 'Xls', 'Html']);
-// Export to PDF (.pdf)
-$helper->log('Write to PDF format');
-IOFactory::registerWriter('Pdf', \PhpOffice\PhpSpreadsheet\Writer\Pdf\Dompdf::class);
-$helper->write($spreadsheet, __FILE__, ['Pdf']);
+if (\PHP_VERSION_ID < 80000) {
+ // Export to PDF (.pdf)
+ $helper->log('Write to PDF format');
+ IOFactory::registerWriter('Pdf', \PhpOffice\PhpSpreadsheet\Writer\Pdf\Dompdf::class);
+ $helper->write($spreadsheet, __FILE__, ['Pdf']);
+}
// Remove first two rows with field headers before exporting to CSV
$helper->log('Removing first two heading rows for CSV export');
diff --git a/samples/Basic/42_RichText.php b/samples/Basic/42_RichText.php
index 43b35a62..d5fa85b4 100644
--- a/samples/Basic/42_RichText.php
+++ b/samples/Basic/42_RichText.php
@@ -30,7 +30,7 @@ $html1 = '
while this block uses an underline.
-
+
I want to eat healthy food pizza.
';
diff --git a/samples/Basic/45_Quadratic_equation_solver.php b/samples/Basic/45_Quadratic_equation_solver.php
index a59a0ceb..84c126aa 100644
--- a/samples/Basic/45_Quadratic_equation_solver.php
+++ b/samples/Basic/45_Quadratic_equation_solver.php
@@ -1,4 +1,5 @@
setActiveSheetIndex(0);
+
+// Set up some basic data for a timesheet
+$worksheet
+ ->setCellValue('A1', 'Charge Rate/hour:')
+ ->setCellValue('B1', '7.50')
+ ->setCellValue('A3', 'Date')
+ ->setCellValue('B3', 'Hours')
+ ->setCellValue('C3', 'Charge');
+
+// Define named range using an absolute cell reference
+$spreadsheet->addNamedRange(new NamedRange('CHARGE_RATE', $worksheet, '=$B$1'));
+
+$workHours = [
+ '2020-0-06' => 7.5,
+ '2020-0-07' => 7.25,
+ '2020-0-08' => 6.5,
+ '2020-0-09' => 7.0,
+ '2020-0-10' => 5.5,
+];
+
+// Populate the Timesheet
+$startRow = 4;
+$row = $startRow;
+foreach ($workHours as $date => $hours) {
+ $worksheet
+ ->setCellValue("A{$row}", $date)
+ ->setCellValue("B{$row}", $hours)
+ ->setCellValue("C{$row}", "=B{$row}*CHARGE_RATE");
+ ++$row;
+}
+$endRow = $row - 1;
+
+++$row;
+$worksheet
+ ->setCellValue("B{$row}", "=SUM(B{$startRow}:B{$endRow})")
+ ->setCellValue("C{$row}", "=SUM(C{$startRow}:C{$endRow})");
+
+echo sprintf(
+ 'Worked %.2f hours at a rate of %.2f - Charge to the client is %.2f',
+ $worksheet->getCell("B{$row}")->getCalculatedValue(),
+ $worksheet->getCell('B1')->getValue(),
+ $worksheet->getCell("C{$row}")->getCalculatedValue()
+), PHP_EOL;
+
+$outputFileName = 'AbsoluteNamedRange.xlsx';
+$writer = IOFactory::createWriter($spreadsheet, 'Xlsx');
+$writer->save($outputFileName);
diff --git a/samples/DefinedNames/CrossWorksheetNamedFormula.php b/samples/DefinedNames/CrossWorksheetNamedFormula.php
new file mode 100644
index 00000000..b441e0f7
--- /dev/null
+++ b/samples/DefinedNames/CrossWorksheetNamedFormula.php
@@ -0,0 +1,99 @@
+setActiveSheetIndex(0);
+setYearlyData($worksheet, '2019', $data2019);
+$worksheet = $spreadsheet->addSheet(new Worksheet($spreadsheet));
+setYearlyData($worksheet, '2020', $data2020);
+$worksheet = $spreadsheet->addSheet(new Worksheet($spreadsheet));
+setYearlyData($worksheet, '2020', [], 'GROWTH');
+
+function setYearlyData(Worksheet $worksheet, string $year, $yearlyData, ?string $title = null): void
+{
+ // Set up some basic data
+ $worksheetTitle = $title ?: $year;
+ $worksheet
+ ->setTitle($worksheetTitle)
+ ->setCellValue('A1', 'Month')
+ ->setCellValue('B1', $worksheetTitle === 'GROWTH' ? 'Growth' : 'Sales')
+ ->setCellValue('C1', $worksheetTitle === 'GROWTH' ? 'Profit Growth' : 'Margin')
+ ->setCellValue('A2', Date::stringToExcel("{$year}-01-01"));
+ for ($row = 3; $row <= 13; ++$row) {
+ $worksheet->setCellValue("A{$row}", '=NEXT_MONTH');
+ }
+
+ if (!empty($yearlyData)) {
+ $worksheet->fromArray($yearlyData, null, 'B2');
+ } else {
+ for ($row = 2; $row <= 13; ++$row) {
+ $worksheet->setCellValue("B{$row}", '=GROWTH');
+ $worksheet->setCellValue("C{$row}", '=PROFIT_GROWTH');
+ }
+ }
+
+ $worksheet->getStyle('A1:C1')
+ ->getFont()->setBold(true);
+ $worksheet->getStyle('A2:A13')
+ ->getNumberFormat()
+ ->setFormatCode('mmmm');
+ $worksheet->getStyle('B2:C13')
+ ->getNumberFormat()
+ ->setFormatCode($worksheetTitle === 'GROWTH' ? '0.00%' : '_-€* #,##0_-');
+}
+
+// Add some Named Formulae
+// The first to store our tax rate
+$spreadsheet->addNamedFormula(new NamedFormula('NEXT_MONTH', $worksheet, '=EDATE(OFFSET($A1,-1,0),1)'));
+$spreadsheet->addNamedFormula(new NamedFormula('GROWTH', $worksheet, "=IF('2020'!\$B1=\"\",\"-\",(('2020'!\$B1/'2019'!\$B1)-1))"));
+$spreadsheet->addNamedFormula(new NamedFormula('PROFIT_GROWTH', $worksheet, "=IF('2020'!\$C1=\"\",\"-\",(('2020'!\$C1/'2019'!\$C1)-1))"));
+
+for ($row = 2; $row <= 7; ++$row) {
+ $month = $worksheet->getCell("A{$row}")->getFormattedValue();
+ $growth = $worksheet->getCell("B{$row}")->getFormattedValue();
+ $profitGrowth = $worksheet->getCell("C{$row}")->getFormattedValue();
+
+ echo "Growth for {$month} is {$growth}, with a Profit Growth of {$profitGrowth}", PHP_EOL;
+}
+
+$outputFileName = 'CrossWorksheetNamedFormula.xlsx';
+$writer = IOFactory::createWriter($spreadsheet, 'Xlsx');
+$writer->save($outputFileName);
diff --git a/samples/DefinedNames/NamedFormulaeAndRanges.php b/samples/DefinedNames/NamedFormulaeAndRanges.php
new file mode 100644
index 00000000..b3f94efc
--- /dev/null
+++ b/samples/DefinedNames/NamedFormulaeAndRanges.php
@@ -0,0 +1,74 @@
+setActiveSheetIndex(0);
+
+// Set up some basic data for a timesheet
+$worksheet
+ ->setCellValue('A1', 'Charge Rate/hour:')
+ ->setCellValue('B1', '7.50')
+ ->setCellValue('A3', 'Date')
+ ->setCellValue('B3', 'Hours')
+ ->setCellValue('C3', 'Charge');
+
+// Define named ranges
+// CHARGE_RATE is an absolute cell reference that always points to cell B1
+$spreadsheet->addNamedRange(new NamedRange('CHARGE_RATE', $worksheet, '=$B$1'));
+// HOURS_PER_DAY is a relative cell reference that always points to column B, but to a cell in the row where it is used
+$spreadsheet->addNamedRange(new NamedRange('HOURS_PER_DAY', $worksheet, '=$B1'));
+// Set up the formula for calculating the daily charge
+$spreadsheet->addNamedFormula(new NamedFormula('DAILY_CHARGE', null, '=HOURS_PER_DAY*CHARGE_RATE'));
+// Set up the formula for calculating the column totals
+$spreadsheet->addNamedFormula(new NamedFormula('COLUMN_TOTALS', null, '=SUM(COLUMN_DATA_VALUES)'));
+
+$workHours = [
+ '2020-0-06' => 7.5,
+ '2020-0-07' => 7.25,
+ '2020-0-08' => 6.5,
+ '2020-0-09' => 7.0,
+ '2020-0-10' => 5.5,
+];
+
+// Populate the Timesheet
+$startRow = 4;
+$row = $startRow;
+foreach ($workHours as $date => $hours) {
+ $worksheet
+ ->setCellValue("A{$row}", $date)
+ ->setCellValue("B{$row}", $hours)
+ ->setCellValue("C{$row}", '=DAILY_CHARGE');
+ ++$row;
+}
+$endRow = $row - 1;
+
+// COLUMN_TOTAL is another relative cell reference that always points to the same range of rows but to cell in the column where it is used
+$spreadsheet->addNamedRange(new NamedRange('COLUMN_DATA_VALUES', $worksheet, "=A\${$startRow}:A\${$endRow}"));
+
+++$row;
+$worksheet
+ ->setCellValue("B{$row}", '=COLUMN_TOTALS')
+ ->setCellValue("C{$row}", '=COLUMN_TOTALS');
+
+echo sprintf(
+ 'Worked %.2f hours at a rate of %.2f - Charge to the client is %.2f',
+ $worksheet->getCell("B{$row}")->getCalculatedValue(),
+ $worksheet->getCell('B1')->getValue(),
+ $worksheet->getCell("C{$row}")->getCalculatedValue()
+), PHP_EOL;
+
+$outputFileName = 'NamedFormulaeAndRanges.xlsx';
+$writer = IOFactory::createWriter($spreadsheet, 'Xlsx');
+$writer->save($outputFileName);
diff --git a/samples/DefinedNames/RelativeNamedRange.php b/samples/DefinedNames/RelativeNamedRange.php
new file mode 100644
index 00000000..1f712017
--- /dev/null
+++ b/samples/DefinedNames/RelativeNamedRange.php
@@ -0,0 +1,66 @@
+setActiveSheetIndex(0);
+
+// Set up some basic data for a timesheet
+$worksheet
+ ->setCellValue('A1', 'Charge Rate/hour:')
+ ->setCellValue('B1', '7.50')
+ ->setCellValue('A3', 'Date')
+ ->setCellValue('B3', 'Hours')
+ ->setCellValue('C3', 'Charge');
+
+// Define named ranges
+// CHARGE_RATE is an absolute cell reference that always points to cell B1
+$spreadsheet->addNamedRange(new NamedRange('CHARGE_RATE', $worksheet, '=$B$1'));
+// HOURS_PER_DAY is a relative cell reference that always points to column B, but to a cell in the row where it is used
+$spreadsheet->addNamedRange(new NamedRange('HOURS_PER_DAY', $worksheet, '=$B1'));
+
+$workHours = [
+ '2020-0-06' => 7.5,
+ '2020-0-07' => 7.25,
+ '2020-0-08' => 6.5,
+ '2020-0-09' => 7.0,
+ '2020-0-10' => 5.5,
+];
+
+// Populate the Timesheet
+$startRow = 4;
+$row = $startRow;
+foreach ($workHours as $date => $hours) {
+ $worksheet
+ ->setCellValue("A{$row}", $date)
+ ->setCellValue("B{$row}", $hours)
+ ->setCellValue("C{$row}", '=HOURS_PER_DAY*CHARGE_RATE');
+ ++$row;
+}
+$endRow = $row - 1;
+
+++$row;
+$worksheet
+ ->setCellValue("B{$row}", "=SUM(B{$startRow}:B{$endRow})")
+ ->setCellValue("C{$row}", "=SUM(C{$startRow}:C{$endRow})");
+
+echo sprintf(
+ 'Worked %.2f hours at a rate of %.2f - Charge to the client is %.2f',
+ $worksheet->getCell("B{$row}")->getCalculatedValue(),
+ $worksheet->getCell('B1')->getValue(),
+ $worksheet->getCell("C{$row}")->getCalculatedValue()
+), PHP_EOL;
+
+$outputFileName = 'RelativeNamedRange.xlsx';
+$writer = IOFactory::createWriter($spreadsheet, 'Xlsx');
+$writer->save($outputFileName);
diff --git a/samples/DefinedNames/RelativeNamedRange2.php b/samples/DefinedNames/RelativeNamedRange2.php
new file mode 100644
index 00000000..b6a6f8d1
--- /dev/null
+++ b/samples/DefinedNames/RelativeNamedRange2.php
@@ -0,0 +1,69 @@
+setActiveSheetIndex(0);
+
+// Set up some basic data for a timesheet
+$worksheet
+ ->setCellValue('A1', 'Charge Rate/hour:')
+ ->setCellValue('B1', '7.50')
+ ->setCellValue('A3', 'Date')
+ ->setCellValue('B3', 'Hours')
+ ->setCellValue('C3', 'Charge');
+
+// Define named ranges
+// CHARGE_RATE is an absolute cell reference that always points to cell B1
+$spreadsheet->addNamedRange(new NamedRange('CHARGE_RATE', $worksheet, '=$B$1'));
+// HOURS_PER_DAY is a relative cell reference that always points to column B, but to a cell in the row where it is used
+$spreadsheet->addNamedRange(new NamedRange('HOURS_PER_DAY', $worksheet, '=$B1'));
+
+$workHours = [
+ '2020-0-06' => 7.5,
+ '2020-0-07' => 7.25,
+ '2020-0-08' => 6.5,
+ '2020-0-09' => 7.0,
+ '2020-0-10' => 5.5,
+];
+
+// Populate the Timesheet
+$startRow = 4;
+$row = $startRow;
+foreach ($workHours as $date => $hours) {
+ $worksheet
+ ->setCellValue("A{$row}", $date)
+ ->setCellValue("B{$row}", $hours)
+ ->setCellValue("C{$row}", '=HOURS_PER_DAY*CHARGE_RATE');
+ ++$row;
+}
+$endRow = $row - 1;
+
+// COLUMN_TOTAL is another relative cell reference that always points to the same range of rows but to cell in the column where it is used
+$spreadsheet->addNamedRange(new NamedRange('COLUMN_DATA_VALUES', $worksheet, "=A\${$startRow}:A\${$endRow}"));
+
+++$row;
+$worksheet
+ ->setCellValue("B{$row}", '=SUM(COLUMN_DATA_VALUES)')
+ ->setCellValue("C{$row}", '=SUM(COLUMN_DATA_VALUES)');
+
+echo sprintf(
+ 'Worked %.2f hours at a rate of %.2f - Charge to the client is %.2f',
+ $worksheet->getCell("B{$row}")->getCalculatedValue(),
+ $worksheet->getCell('B1')->getValue(),
+ $worksheet->getCell("C{$row}")->getCalculatedValue()
+), PHP_EOL;
+
+$outputFileName = 'RelativeNamedRange2.xlsx';
+$writer = IOFactory::createWriter($spreadsheet, 'Xlsx');
+$writer->save($outputFileName);
diff --git a/samples/DefinedNames/RelativeNamedRangeAsFunction.php b/samples/DefinedNames/RelativeNamedRangeAsFunction.php
new file mode 100644
index 00000000..527cd43b
--- /dev/null
+++ b/samples/DefinedNames/RelativeNamedRangeAsFunction.php
@@ -0,0 +1,72 @@
+setActiveSheetIndex(0);
+
+// Set up some basic data for a timesheet
+$worksheet
+ ->setCellValue('A1', 'Charge Rate/hour:')
+ ->setCellValue('B1', '7.50')
+ ->setCellValue('A3', 'Date')
+ ->setCellValue('B3', 'Hours')
+ ->setCellValue('C3', 'Charge');
+
+// Define named ranges
+// CHARGE_RATE is an absolute cell reference that always points to cell B1
+$spreadsheet->addNamedRange(new NamedRange('CHARGE_RATE', $worksheet, '=$B$1'));
+// HOURS_PER_DAY is a relative cell reference that always points to column B, but to a cell in the row where it is used
+$spreadsheet->addNamedRange(new NamedRange('HOURS_PER_DAY', $worksheet, '=$B1'));
+
+$workHours = [
+ '2020-0-06' => 7.5,
+ '2020-0-07' => 7.25,
+ '2020-0-08' => 6.5,
+ '2020-0-09' => 7.0,
+ '2020-0-10' => 5.5,
+];
+
+// Populate the Timesheet
+$startRow = 4;
+$row = $startRow;
+foreach ($workHours as $date => $hours) {
+ $worksheet
+ ->setCellValue("A{$row}", $date)
+ ->setCellValue("B{$row}", $hours)
+ ->setCellValue("C{$row}", '=HOURS_PER_DAY*CHARGE_RATE');
+ ++$row;
+}
+$endRow = $row - 1;
+
+// COLUMN_TOTAL is another relative cell reference that always points to the same range of rows but to cell in the column where it is used
+// To avoid including the current row,or having to hard-code the range itself (as we did in the previous example)
+// we wrap it in a named formula using the OFFSET() function
+$spreadsheet->addNamedFormula(new NamedFormula('COLUMN_DATA_VALUES', $worksheet, '=OFFSET(A$4:A1, -1, 0)'));
+
+++$row;
+$worksheet
+ ->setCellValue("B{$row}", '=SUM(COLUMN_DATA_VALUES)')
+ ->setCellValue("C{$row}", '=SUM(COLUMN_DATA_VALUES)');
+
+echo sprintf(
+ 'Worked %.2f hours at a rate of %.2f - Charge to the client is %.2f',
+ $worksheet->getCell("B{$row}")->getCalculatedValue(),
+ $worksheet->getCell('B1')->getValue(),
+ $worksheet->getCell("C{$row}")->getCalculatedValue()
+), PHP_EOL;
+
+$outputFileName = 'RelativeNamedRangeAsFunction.xlsx';
+$writer = IOFactory::createWriter($spreadsheet, 'Xlsx');
+$writer->save($outputFileName);
diff --git a/samples/DefinedNames/ScopedNamedRange.php b/samples/DefinedNames/ScopedNamedRange.php
new file mode 100644
index 00000000..5ea7e48a
--- /dev/null
+++ b/samples/DefinedNames/ScopedNamedRange.php
@@ -0,0 +1,81 @@
+setActiveSheetIndex(0);
+$worksheet->setTitle('Base Data');
+
+// Set up some basic data for a timesheet
+$worksheet
+ ->setCellValue('A1', 'Charge Rate/hour:')
+ ->setCellValue('B1', '7.50');
+
+// Define a global named range on the first worksheet for our Charge Rate
+// CHARGE_RATE is an absolute cell reference that always points to cell B1
+// Because it is defined globally, it will still be usable from any worksheet in the spreadsheet
+$spreadsheet->addNamedRange(new NamedRange('CHARGE_RATE', $worksheet, '=$B$1'));
+
+// Create a second worksheet as our client timesheet
+$worksheet = $spreadsheet->addSheet(new \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet($spreadsheet, 'Client Timesheet'));
+
+// Define named ranges
+// HOURS_PER_DAY is a relative cell reference that always points to column B, but to a cell in the row where it is used
+$spreadsheet->addNamedRange(new NamedRange('HOURS_PER_DAY', $worksheet, '=$B1'));
+
+// Set up some basic data for a timesheet
+$worksheet
+ ->setCellValue('A1', 'Date')
+ ->setCellValue('B1', 'Hours')
+ ->setCellValue('C1', 'Charge');
+
+$workHours = [
+ '2020-0-06' => 7.5,
+ '2020-0-07' => 7.25,
+ '2020-0-08' => 6.5,
+ '2020-0-09' => 7.0,
+ '2020-0-10' => 5.5,
+];
+
+// Populate the Timesheet
+$startRow = 2;
+$row = $startRow;
+foreach ($workHours as $date => $hours) {
+ $worksheet
+ ->setCellValue("A{$row}", $date)
+ ->setCellValue("B{$row}", $hours)
+ ->setCellValue("C{$row}", '=HOURS_PER_DAY*CHARGE_RATE');
+ ++$row;
+}
+$endRow = $row - 1;
+
+// COLUMN_TOTAL is another relative cell reference that always points to the same range of rows but to cell in the column where it is used
+$spreadsheet->addNamedRange(new NamedRange('COLUMN_DATA_VALUES', $worksheet, "=A\${$startRow}:A\${$endRow}"));
+
+++$row;
+$worksheet
+ ->setCellValue("B{$row}", '=SUM(COLUMN_DATA_VALUES)')
+ ->setCellValue("C{$row}", '=SUM(COLUMN_DATA_VALUES)');
+
+echo sprintf(
+ 'Worked %.2f hours at a rate of %s - Charge to the client is %.2f',
+ $worksheet->getCell("B{$row}")->getCalculatedValue(),
+ $chargeRateCellValue = $spreadsheet
+ ->getSheetByName($spreadsheet->getNamedRange('CHARGE_RATE')->getWorksheet()->getTitle())
+ ->getCell($spreadsheet->getNamedRange('CHARGE_RATE')->getCellsInRange()[0])->getValue(),
+ $worksheet->getCell("C{$row}")->getCalculatedValue()
+), PHP_EOL;
+
+$outputFileName = 'ScopedNamedRange.xlsx';
+$writer = IOFactory::createWriter($spreadsheet, 'Xlsx');
+$writer->save($outputFileName);
diff --git a/samples/DefinedNames/ScopedNamedRange2.php b/samples/DefinedNames/ScopedNamedRange2.php
new file mode 100644
index 00000000..8e610418
--- /dev/null
+++ b/samples/DefinedNames/ScopedNamedRange2.php
@@ -0,0 +1,98 @@
+setActiveSheetIndex(0);
+
+$clients = [
+ 'Client #1 - Full Hourly Rate' => [
+ '2020-0-06' => 2.5,
+ '2020-0-07' => 2.25,
+ '2020-0-08' => 6.0,
+ '2020-0-09' => 3.0,
+ '2020-0-10' => 2.25,
+ ],
+ 'Client #2 - Full Hourly Rate' => [
+ '2020-0-06' => 1.5,
+ '2020-0-07' => 2.75,
+ '2020-0-08' => 0.0,
+ '2020-0-09' => 4.5,
+ '2020-0-10' => 3.5,
+ ],
+ 'Client #3 - Reduced Hourly Rate' => [
+ '2020-0-06' => 3.5,
+ '2020-0-07' => 2.5,
+ '2020-0-08' => 1.5,
+ '2020-0-09' => 0.0,
+ '2020-0-10' => 1.25,
+ ],
+];
+
+foreach ($clients as $clientName => $workHours) {
+ $worksheet = $spreadsheet->addSheet(new \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet($spreadsheet, $clientName));
+
+ // Set up some basic data for a timesheet
+ $worksheet
+ ->setCellValue('A1', 'Charge Rate/hour:')
+ ->setCellValue('B1', '7.50')
+ ->setCellValue('A3', 'Date')
+ ->setCellValue('B3', 'Hours')
+ ->setCellValue('C3', 'Charge');
+
+ // Define named ranges
+ // CHARGE_RATE is an absolute cell reference that always points to cell B1
+ $spreadsheet->addNamedRange(new NamedRange('CHARGE_RATE', $worksheet, '=$B$1', true));
+ // HOURS_PER_DAY is a relative cell reference that always points to column B, but to a cell in the row where it is used
+ $spreadsheet->addNamedRange(new NamedRange('HOURS_PER_DAY', $worksheet, '=$B1', true));
+
+ // Populate the Timesheet
+ $startRow = 4;
+ $row = $startRow;
+ foreach ($workHours as $date => $hours) {
+ $worksheet
+ ->setCellValue("A{$row}", $date)
+ ->setCellValue("B{$row}", $hours)
+ ->setCellValue("C{$row}", '=HOURS_PER_DAY*CHARGE_RATE');
+ ++$row;
+ }
+ $endRow = $row - 1;
+
+ // COLUMN_TOTAL is another relative cell reference that always points to the same range of rows but to cell in the column where it is used
+ $spreadsheet->addNamedRange(new NamedRange('COLUMN_TOTAL', $worksheet, "=A\${$startRow}:A\${$endRow}", true));
+
+ ++$row;
+ $worksheet
+ ->setCellValue("B{$row}", '=SUM(COLUMN_TOTAL)')
+ ->setCellValue("C{$row}", '=SUM(COLUMN_TOTAL)');
+}
+$spreadsheet->removeSheetByIndex(0);
+
+// Set the reduced charge rate for our special client
+$worksheet
+ ->setCellValue('B1', 4.5);
+
+foreach ($spreadsheet->getAllSheets() as $worksheet) {
+ echo sprintf(
+ 'Worked %.2f hours for "%s" at a rate of %.2f - Charge to the client is %.2f',
+ $worksheet->getCell("B{$row}")->getCalculatedValue(),
+ $worksheet->getTitle(),
+ $worksheet->getCell('B1')->getValue(),
+ $worksheet->getCell("C{$row}")->getCalculatedValue()
+ ), PHP_EOL;
+}
+$worksheet = $spreadsheet->setActiveSheetIndex(0);
+
+$outputFileName = 'ScopedNamedRange2.xlsx';
+$writer = IOFactory::createWriter($spreadsheet, 'Xlsx');
+$writer->save($outputFileName);
diff --git a/samples/DefinedNames/SimpleNamedFormula.php b/samples/DefinedNames/SimpleNamedFormula.php
new file mode 100644
index 00000000..8e0fc972
--- /dev/null
+++ b/samples/DefinedNames/SimpleNamedFormula.php
@@ -0,0 +1,52 @@
+setActiveSheetIndex(0);
+
+// Add some Named Formulae
+// The first to store our tax rate
+$spreadsheet->addNamedFormula(new NamedFormula('TAX_RATE', $worksheet, '=19%'));
+// The second to calculate the Tax on a Price value (Note that `PRICE` is defined later as a Named Range)
+$spreadsheet->addNamedFormula(new NamedFormula('TAX', $worksheet, '=PRICE*TAX_RATE'));
+
+// Set up some basic data
+$worksheet
+ ->setCellValue('A1', 'Tax Rate:')
+ ->setCellValue('B1', '=TAX_RATE')
+ ->setCellValue('A3', 'Net Price:')
+ ->setCellValue('B3', 19.99)
+ ->setCellValue('A4', 'Tax:')
+ ->setCellValue('A5', 'Price including Tax:');
+
+// Define a named range that we can use in our formulae
+$spreadsheet->addNamedRange(new NamedRange('PRICE', $worksheet, '=$B$3'));
+
+// Reference the defined formulae in worksheet formulae
+$worksheet
+ ->setCellValue('B4', '=TAX')
+ ->setCellValue('B5', '=PRICE+TAX');
+
+echo sprintf(
+ 'With a Tax Rate of %.2f and a net price of %.2f, Tax is %.2f and the gross price is %.2f',
+ $worksheet->getCell('B1')->getCalculatedValue(),
+ $worksheet->getCell('B3')->getValue(),
+ $worksheet->getCell('B4')->getCalculatedValue(),
+ $worksheet->getCell('B5')->getCalculatedValue()
+), PHP_EOL;
+
+$outputFileName = 'SimpleNamedFormula.xlsx';
+$writer = IOFactory::createWriter($spreadsheet, 'Xlsx');
+$writer->save($outputFileName);
diff --git a/samples/DefinedNames/SimpleNamedRange.php b/samples/DefinedNames/SimpleNamedRange.php
new file mode 100644
index 00000000..ee05c68f
--- /dev/null
+++ b/samples/DefinedNames/SimpleNamedRange.php
@@ -0,0 +1,46 @@
+setActiveSheetIndex(0);
+
+// Set up some basic data
+$worksheet
+ ->setCellValue('A1', 'Tax Rate:')
+ ->setCellValue('B1', '=19%')
+ ->setCellValue('A3', 'Net Price:')
+ ->setCellValue('B3', 12.99)
+ ->setCellValue('A4', 'Tax:')
+ ->setCellValue('A5', 'Price including Tax:');
+
+// Define named ranges
+$spreadsheet->addNamedRange(new NamedRange('TAX_RATE', $worksheet, '=$B$1'));
+$spreadsheet->addNamedRange(new NamedRange('PRICE', $worksheet, '=$B$3'));
+
+// Reference that defined name in a formula
+$worksheet
+ ->setCellValue('B4', '=PRICE*TAX_RATE')
+ ->setCellValue('B5', '=PRICE*(1+TAX_RATE)');
+
+echo sprintf(
+ 'With a Tax Rate of %.2f and a net price of %.2f, Tax is %.2f and the gross price is %.2f',
+ $worksheet->getCell('B1')->getCalculatedValue(),
+ $worksheet->getCell('B3')->getValue(),
+ $worksheet->getCell('B4')->getCalculatedValue(),
+ $worksheet->getCell('B5')->getCalculatedValue()
+), PHP_EOL;
+
+$outputFileName = 'SimpleNamedRange.xlsx';
+$writer = IOFactory::createWriter($spreadsheet, 'Xlsx');
+$writer->save($outputFileName);
diff --git a/samples/Pdf/21a_Pdf.php b/samples/Pdf/21a_Pdf.php
new file mode 100644
index 00000000..b5572afe
--- /dev/null
+++ b/samples/Pdf/21a_Pdf.php
@@ -0,0 +1,25 @@
+log('Hide grid lines');
+$spreadsheet->getActiveSheet()->setShowGridLines(false);
+
+$helper->log('Set orientation to landscape');
+$spreadsheet->getActiveSheet()->getPageSetup()->setOrientation(PageSetup::ORIENTATION_LANDSCAPE);
+$spreadsheet->setActiveSheetIndex(0)->setPrintGridlines(true);
+
+function changeGridlines(string $html): string
+{
+ return str_replace('{border: 1px solid black;}', '{border: 2px dashed red;}', $html);
+}
+
+$helper->log('Write to Mpdf');
+$writer = new Mpdf($spreadsheet);
+$filename = $helper->getFileName('21a_Pdf_mpdf.xlsx', 'pdf');
+$writer->setEditHtmlCallback('changeGridlines');
+$writer->save($filename);
diff --git a/samples/Pdf/21b_Pdf.php b/samples/Pdf/21b_Pdf.php
new file mode 100644
index 00000000..ad2f609b
--- /dev/null
+++ b/samples/Pdf/21b_Pdf.php
@@ -0,0 +1,55 @@
+.*
```
You might want to see:
-``` html
+```html
```
You can use the following code to achieve this result:
-``` php
+```php
$writer->setImagesRoot('http://www.example.com');
```
@@ -661,7 +675,7 @@ By default, this writer pre-calculates all formulas in the spreadsheet.
This can be slow on large spreadsheets, and maybe even unwanted. You can
however disable formula pre-calculation:
-``` php
+```php
$writer = new \PhpOffice\PhpSpreadsheet\Writer\Html($spreadsheet);
$writer->setPreCalculateFormulas(false);
@@ -686,14 +700,14 @@ Supported methods:
Here's an example which retrieves all parts independently and merges
them into a resulting HTML page:
-``` php
+```php
$writer = new \PhpOffice\PhpSpreadsheet\Writer\Html($spreadsheet);
$hdr = $writer->generateHTMLHeader();
$sty = $writer->generateStyles(false); // do not write
$newstyle = <<