' . PHP_EOL;
foreach ($objWorksheet->getRowIterator() as $row) {
@@ -278,11 +278,11 @@ foreach ($objWorksheet->getRowIterator() as $row) {
$cellIterator = $row->getCellIterator();
$cellIterator->setIterateOnlyExistingCells(FALSE); // This loops through all cells,
// even if a cell value is not set.
- // By default, only cells that have a value
+ // By default, only cells that have a value
// set will be iterated.
foreach ($cellIterator as $cell) {
- echo '| ' .
- $cell->getValue() .
+ echo ' | ' .
+ $cell->getValue() .
' | ' . PHP_EOL;
}
echo '' . PHP_EOL;
@@ -299,28 +299,28 @@ Setting the cell iterator's setIterateOnlyExistingCells() to FALSE will loop all
One can use the possibility to access cell values by column and row index like (0,1) instead of 'A1' for reading and writing cell values in loops.
-Note: In PHPExcel column index is 0-based while row index is 1-based. That means 'A1' ~ (0,1)
+Note: In PhpSpreadsheet column index is 0-based while row index is 1-based. That means 'A1' ~ (0,1)
Below is an example where we read all the values in a worksheet and display them in a table.
```php
-$objReader = PHPExcel_IOFactory::createReader('Xlsx');
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader('Xlsx');
$objReader->setReadDataOnly(TRUE);
-$objPHPExcel = $objReader->load("test.xlsx");
+$spreadsheet = $objReader->load("test.xlsx");
-$objWorksheet = $objPHPExcel->getActiveSheet();
+$objWorksheet = $spreadsheet->getActiveSheet();
// Get the highest row and column numbers referenced in the worksheet
$highestRow = $objWorksheet->getHighestRow(); // e.g. 10
$highestColumn = $objWorksheet->getHighestColumn(); // e.g 'F'
-$highestColumnIndex = PHPExcel_Cell::columnIndexFromString($highestColumn); // e.g. 5
+$highestColumnIndex = \PhpOffice\PhpSpreadsheet\Cell::columnIndexFromString($highestColumn); // e.g. 5
echo '' . "\n";
for ($row = 1; $row <= $highestRow; ++$row) {
echo '' . PHP_EOL;
for ($col = 0; $col <= $highestColumnIndex; ++$col) {
- echo '| ' .
+ echo ' | ' .
$objWorksheet->getCellByColumnAndRow($col, $row)
- ->getValue() .
+ ->getValue() .
' | ' . PHP_EOL;
}
echo '
' . PHP_EOL;
@@ -331,11 +331,11 @@ echo '
' . PHP_EOL;
Alternatively, you can take advantage of PHP's "Perl-style" character incrementors to loop through the cells by coordinate:
```php
-$objReader = PHPExcel_IOFactory::createReader('Xlsx');
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader('Xlsx');
$objReader->setReadDataOnly(TRUE);
-$objPHPExcel = $objReader->load("test.xlsx");
+$spreadsheet = $objReader->load("test.xlsx");
-$objWorksheet = $objPHPExcel->getActiveSheet();
+$objWorksheet = $spreadsheet->getActiveSheet();
// Get the highest row number and column letter referenced in the worksheet
$highestRow = $objWorksheet->getHighestRow(); // e.g. 10
$highestColumn = $objWorksheet->getHighestColumn(); // e.g 'F'
@@ -346,9 +346,9 @@ echo '' . "\n";
for ($row = 1; $row <= $highestRow; ++$row) {
echo '' . PHP_EOL;
for ($col = 'A'; $col != $highestColumn; ++$col) {
- echo '| ' .
+ echo ' | ' .
$objWorksheet->getCell($col . $row)
- ->getValue() .
+ ->getValue() .
' | ' . PHP_EOL;
}
echo '
' . PHP_EOL;
@@ -360,31 +360,31 @@ Note that we can't use a <= comparison here, because 'AA' would match as <= 'B',
### Using value binders to facilitate data entry
-Internally, PHPExcel uses a default PHPExcel_Cell_IValueBinder implementation (PHPExcel_Cell_DefaultValueBinder) to determine data types of entered data using a cell's `setValue()` method (the `setValueExplicit()` method bypasses this check).
+Internally, PhpSpreadsheet uses a default \PhpOffice\PhpSpreadsheet\Cell\IValueBinder implementation (\PhpOffice\PhpSpreadsheet\Cell\DefaultValueBinder) to determine data types of entered data using a cell's `setValue()` method (the `setValueExplicit()` method bypasses this check).
-Optionally, the default behaviour of PHPExcel can be modified, allowing easier data entry. For example, a PHPExcel_Cell_AdvancedValueBinder class is available. It automatically converts percentages, number in scientific format, and dates entered as strings to the correct format, also setting the cell's style information. The following example demonstrates how to set the value binder in PHPExcel:
+Optionally, the default behaviour of PhpSpreadsheet can be modified, allowing easier data entry. For example, a \PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder class is available. It automatically converts percentages, number in scientific format, and dates entered as strings to the correct format, also setting the cell's style information. The following example demonstrates how to set the value binder in PhpSpreadsheet:
```php
-/** PHPExcel */
-require_once 'PHPExcel.php';
+/** PhpSpreadsheet */
+require_once 'src/Boostrap.php';
// Set value binder
-PHPExcel_Cell::setValueBinder( new PHPExcel_Cell_AdvancedValueBinder() );
+\PhpOffice\PhpSpreadsheet\Cell::setValueBinder( new \PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder() );
-// Create new PHPExcel object
-$objPHPExcel = new PHPExcel();
+// Create new Spreadsheet object
+$spreadsheet = new \PhpOffice\PhpSpreadsheet\Spreadsheet();
// ...
// Add some data, resembling some different data types
-$objPHPExcel->getActiveSheet()->setCellValue('A4', 'Percentage value:');
+$spreadsheet->getActiveSheet()->setCellValue('A4', 'Percentage value:');
// Converts the string value to 0.1 and sets percentage cell style
-$objPHPExcel->getActiveSheet()->setCellValue('B4', '10%');
+$spreadsheet->getActiveSheet()->setCellValue('B4', '10%');
-$objPHPExcel->getActiveSheet()->setCellValue('A5', 'Date/time value:');
+$spreadsheet->getActiveSheet()->setCellValue('A5', 'Date/time value:');
// Converts the string value to an Excel datestamp and sets the date format cell style
-$objPHPExcel->getActiveSheet()->setCellValue('B5', '21 December 1983');
+$spreadsheet->getActiveSheet()->setCellValue('B5', '21 December 1983');
```
-__Creating your own value binder is easy.__
-When advanced value binding is required, you can implement the PHPExcel_Cell_IValueBinder interface or extend the PHPExcel_Cell_DefaultValueBinder or PHPExcel_Cell_AdvancedValueBinder classes.
+__Creating your own value binder is easy.__
+When advanced value binding is required, you can implement the \PhpOffice\PhpSpreadsheet\Cell\IValueBinder interface or extend the \PhpOffice\PhpSpreadsheet\Cell\DefaultValueBinder or \PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder classes.
diff --git a/docs/Overview/08-Recipes.md b/docs/Overview/08-Recipes.md
index 004dac17..7ca846df 100644
--- a/docs/Overview/08-Recipes.md
+++ b/docs/Overview/08-Recipes.md
@@ -1,19 +1,19 @@
-# PHPExcel Developer Documentation
+# PhpSpreadsheet Developer Documentation
-## PHPExcel recipes
+## PhpSpreadsheet recipes
-The following pages offer you some widely-used PHPExcel recipes. Please note that these do NOT offer complete documentation on specific PHPExcel API functions, but just a bump to get you started. If you need specific API functions, please refer to the API documentation.
+The following pages offer you some widely-used PhpSpreadsheet recipes. Please note that these do NOT offer complete documentation on specific PhpSpreadsheet API functions, but just a bump to get you started. If you need specific API functions, please refer to the API documentation.
-For example, REF _Ref191885321 \w \h 4.4.7 REF _Ref191885321 \h Setting a worksheet's page orientation and size covers setting a page orientation to A4. Other paper formats, like US Letter, are not covered in this document, but in the PHPExcel API documentation.
+For example, REF _Ref191885321 \w \h 4.4.7 REF _Ref191885321 \h Setting a worksheet's page orientation and size covers setting a page orientation to A4. Other paper formats, like US Letter, are not covered in this document, but in the PhpSpreadsheet API documentation.
### Setting a spreadsheet's metadata
-PHPExcel allows an easy way to set a spreadsheet's metadata, using document property accessors. Spreadsheet metadata can be useful for finding a specific document in a file repository or a document management system. For example Microsoft Sharepoint uses document metadata to search for a specific document in its document lists.
+PhpSpreadsheet allows an easy way to set a spreadsheet's metadata, using document property accessors. Spreadsheet metadata can be useful for finding a specific document in a file repository or a document management system. For example Microsoft Sharepoint uses document metadata to search for a specific document in its document lists.
Setting spreadsheet metadata is done as follows:
```php
-$objPHPExcel->getProperties()
+$spreadsheet->getProperties()
->setCreator("Maarten Balliauw")
->setLastModifiedBy("Maarten Balliauw")
->setTitle("Office 2007 XLSX Test Document")
@@ -30,13 +30,13 @@ $objPHPExcel->getProperties()
The following line of code sets the active sheet index to the first sheet:
```php
-$objPHPExcel->setActiveSheetIndex(0);
+$spreadsheet->setActiveSheetIndex(0);
```
You can also set the active sheet by its name/title
```php
-$objPHPExcel->setActiveSheetIndexByName('DataSheet')
+$spreadsheet->setActiveSheetIndexByName('DataSheet')
```
will change the currently active sheet to the worksheet called "DataSheet".
@@ -45,54 +45,51 @@ will change the currently active sheet to the worksheet called "DataSheet".
In Excel, dates and Times are stored as numeric values counting the number of days elapsed since 1900-01-01. For example, the date '2008-12-31' is represented as 39813. You can verify this in Microsoft Office Excel by entering that date in a cell and afterwards changing the number format to 'General' so the true numeric value is revealed. Likewise, '3:15 AM' is represented as 0.135417.
-PHPExcel works with UST (Universal Standard Time) date and Time values, but does no internal conversions; so it is up to the developer to ensure that values passed to the date/time conversion functions are UST.
+PhpSpreadsheet works with UST (Universal Standard Time) date and Time values, but does no internal conversions; so it is up to the developer to ensure that values passed to the date/time conversion functions are 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
-/* PHPExcel_Cell_AdvanceValueBinder required for this sample */
-require_once 'PHPExcel/Cell/AdvancedValueBinder.php';
// MySQL-like timestamp '2008-12-31' or date string
-PHPExcel_Cell::setValueBinder( new PHPExcel_Cell_AdvancedValueBinder() );
+\PhpOffice\PhpSpreadsheet\Cell::setValueBinder( new \PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder() );
-$objPHPExcel->getActiveSheet()
+$spreadsheet->getActiveSheet()
->setCellValue('D1', '2008-12-31');
-$objPHPExcel->getActiveSheet()->getStyle('D1')
+$spreadsheet->getActiveSheet()->getStyle('D1')
->getNumberFormat()
- ->setFormatCode(PHPExcel_Style_NumberFormat::FORMAT_DATE_YYYYMMDDSLASH);
+ ->setFormatCode(\PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_YYYYMMDDSLASH);
// PHP-time (Unix time)
$time = gmmktime(0,0,0,12,31,2008); // int(1230681600)
-$objPHPExcel->getActiveSheet()
- ->setCellValue('D1', PHPExcel_Shared_Date::PHPToExcel($time));
-$objPHPExcel->getActiveSheet()->getStyle('D1')
+$spreadsheet->getActiveSheet()
+ ->setCellValue('D1', \PhpOffice\PhpSpreadsheet\Shared\Date::PHPToExcel($time));
+$spreadsheet->getActiveSheet()->getStyle('D1')
->getNumberFormat()
- ->setFormatCode(PHPExcel_Style_NumberFormat::FORMAT_DATE_YYYYMMDDSLASH);
+ ->setFormatCode(\PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_YYYYMMDDSLASH);
// Excel-date/time
-$objPHPExcel->getActiveSheet()->setCellValue('D1', 39813)
-$objPHPExcel->getActiveSheet()->getStyle('D1')
+$spreadsheet->getActiveSheet()->setCellValue('D1', 39813)
+$spreadsheet->getActiveSheet()->getStyle('D1')
->getNumberFormat()
- ->setFormatCode(PHPExcel_Style_NumberFormat::FORMAT_DATE_YYYYMMDDSLASH);
+ ->setFormatCode(\PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_DATE_YYYYMMDDSLASH);
```
-The above methods for entering a date all yield the same result. PHPExcel_Style_NumberFormat provides a lot of pre-defined date formats.
+The above methods for entering a date all yield the same result. \PhpOffice\PhpSpreadsheet\Style\NumberFormat provides a lot of pre-defined date formats.
-The PHPExcel_Shared_Date::PHPToExcel() method will also work with a PHP DateTime object.
+The \PhpOffice\PhpSpreadsheet\Shared\Date::PHPToExcel() method will also work with a PHP DateTime object.
Similarly, times (or date and time values) can be entered in the same fashion: just remember to use an appropriate format code.
__Notes:__
See section "Using value binders to facilitate data entry" to learn more about the AdvancedValueBinder used in the first example.
-In previous versions of PHPExcel up to and including 1.6.6, when a cell had a date-like number format code, it was possible to enter a date directly using an integer PHP-time without converting to Excel date format. Starting with PHPExcel 1.6.7 this is no longer supported.
-Excel can also operate in a 1904-based calendar (default for workbooks saved on Mac). Normally, you do not have to worry about this when using PHPExcel.
+Excel can also operate in a 1904-based calendar (default for workbooks saved on Mac). Normally, you do not have to worry about this when using PhpSpreadsheet.
### Write a formula into a cell
-Inside the Excel file, formulas are always stored as they would appear in an English version of Microsoft Office Excel, and PHPExcel handles all formulae internally in this format. This means that the following rules hold:
+Inside the Excel file, formulas are always stored as they would appear in an English version of Microsoft Office Excel, and PhpSpreadsheet handles all formulae internally in this format. This means that the following rules hold:
- Decimal separator is '.' (period)
- Function argument separator is ',' (comma)
@@ -103,42 +100,42 @@ This is regardless of which language version of Microsoft Office Excel may have
When the final workbook is opened by the user, Microsoft Office Excel will take care of displaying the formula according the applications language. Translation is taken care of by the application!
-The following line of code writes the formula '=IF(C4>500,"profit","loss")' into the cell B8. Note that the formula must start with "=" to make PHPExcel recognise this as a formula.
+The following line of code writes the formula '=IF(C4>500,"profit","loss")' into the cell B8. Note that the formula must start with "=" to make PhpSpreadsheet recognise this as a formula.
```php
-$objPHPExcel->getActiveSheet()->setCellValue('B8','=IF(C4>500,"profit","loss")');
+$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
-$objPHPExcel->getActiveSheet()
+$spreadsheet->getActiveSheet()
->setCellValueExplicit(
'B8',
'=IF(C4>500,"profit","loss")',
- PHPExcel_Cell_DataType::TYPE_STRING
+ \PhpOffice\PhpSpreadsheet\Cell\DataType::TYPE_STRING
);
```
A cell's formula can be read again using the following line of code:
```php
-$formula = $objPHPExcel->getActiveSheet()->getCell('B8')->getValue();
+$formula = $spreadsheet->getActiveSheet()->getCell('B8')->getValue();
```
If you need the calculated value of a cell, use the following code. This is further explained in REF _Ref191885372 \w \h \* MERGEFORMAT 4.4.35.
```php
-$value = $objPHPExcel->getActiveSheet()->getCell('B8')->getCalculatedValue();
+$value = $spreadsheet->getActiveSheet()->getCell('B8')->getCalculatedValue();
```
### Locale Settings for Formulae
-Some localisation elements have been included in PHPExcel. You can set a locale by changing the settings. To set the locale to Russian you would use:
+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
$locale = 'ru';
-$validLocale = PHPExcel_Settings::setLocale($locale);
+$validLocale = \PhpOffice\PhpSpreadsheet\Settings::setLocale($locale);
if (!$validLocale) {
echo 'Unable to set locale to '.$locale." - reverting to en_us
\n";
}
@@ -149,16 +146,16 @@ If Russian language files aren't available, the `setLocale()` method will return
Once you have set a locale, you can translate a formula from its internal English coding.
```php
-$formula = $objPHPExcel->getActiveSheet()->getCell('B8')->getValue();
-$translatedFormula = PHPExcel_Calculation::getInstance()->_translateFormulaToLocale($formula);
+$formula = $spreadsheet->getActiveSheet()->getCell('B8')->getValue();
+$translatedFormula = \PhpOffice\PhpSpreadsheet\Calculation::getInstance()->_translateFormulaToLocale($formula);
```
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
$formula = '=????360(????(2010;2;5);????(2010;12;31);??????)';
-$internalFormula = PHPExcel_Calculation::getInstance()->translateFormulaToEnglish($formula);
-$objPHPExcel->getActiveSheet()->setCellValue('B8',$internalFormula);
+$internalFormula = \PhpOffice\PhpSpreadsheet\Calculation::getInstance()->translateFormulaToEnglish($formula);
+$spreadsheet->getActiveSheet()->setCellValue('B8',$internalFormula);
```
Currently, formula translation only translates the function names, the constants TRUE and FALSE, and the function argument separators.
@@ -188,11 +185,11 @@ At present, the following locale settings are supported:
In Microsoft Office Excel you get a line break in a cell by hitting ALT+"Enter". When you do that, it automatically turns on "wrap text" for the cell.
-Here is how to achieve this in PHPExcel:
+Here is how to achieve this in PhpSpreadsheet:
```php
-$objPHPExcel->getActiveSheet()->getCell('A1')->setValue("hello\nworld");
-$objPHPExcel->getActiveSheet()->getStyle('A1')->getAlignment()->setWrapText(true);
+$spreadsheet->getActiveSheet()->getCell('A1')->setValue("hello\nworld");
+$spreadsheet->getActiveSheet()->getStyle('A1')->getAlignment()->setWrapText(true);
```
__Tip__
@@ -204,10 +201,9 @@ __Tip__
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
-require_once 'PHPExcel/Cell/AdvancedValueBinder.php';
-PHPExcel_Cell::setValueBinder( new PHPExcel_Cell_AdvancedValueBinder() );
+\PhpOffice\PhpSpreadsheet\Cell::setValueBinder( new \PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder() );
-$objPHPExcel->getActiveSheet()->getCell('A1')->setValue("hello\nworld");
+$spreadsheet->getActiveSheet()->getCell('A1')->setValue("hello\nworld");
```
Read more about AdvancedValueBinder.php elsewhere.
@@ -217,10 +213,10 @@ Read more about AdvancedValueBinder.php elsewhere.
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
-$objPHPExcel->getActiveSheet()->getCell('A1')
+$spreadsheet->getActiveSheet()->getCell('A1')
->setValueExplicit(
- '25',
- PHPExcel_Cell_DataType::TYPE_NUMERIC
+ '25',
+ \PhpOffice\PhpSpreadsheet\Cell\DataType::TYPE_NUMERIC
);
```
@@ -229,15 +225,15 @@ $objPHPExcel->getActiveSheet()->getCell('A1')
You can make a cell a clickable URL by setting its hyperlink property:
```php
-$objPHPExcel->getActiveSheet()->setCellValue('E26', 'www.phpexcel.net');
-$objPHPExcel->getActiveSheet()->getCell('E26')->getHyperlink()->setUrl('http://www.phpexcel.net');
+$spreadsheet->getActiveSheet()->setCellValue('E26', 'www.phpexcel.net');
+$spreadsheet->getActiveSheet()->getCell('E26')->getHyperlink()->setUrl('http://www.phpexcel.net');
```
If you want to make a hyperlink to another worksheet/cell, use the following code:
```php
-$objPHPExcel->getActiveSheet()->setCellValue('E26', 'www.phpexcel.net');
-$objPHPExcel->getActiveSheet()->getCell('E26')->getHyperlink()->setUrl("sheet://'Sheetname'!A1");
+$spreadsheet->getActiveSheet()->setCellValue('E26', 'www.phpexcel.net');
+$spreadsheet->getActiveSheet()->getCell('E26')->getHyperlink()->setUrl("sheet://'Sheetname'!A1");
```
### Setting Printer Options for Excel files
@@ -247,25 +243,25 @@ $objPHPExcel->getActiveSheet()->getCell('E26')->getHyperlink()->setUrl("sheet://
Setting a worksheet's page orientation and size can be done using the following lines of code:
```php
-$objPHPExcel->getActiveSheet()->getPageSetup()
- ->setOrientation(PHPExcel_Worksheet_PageSetup::ORIENTATION_LANDSCAPE);
-$objPHPExcel->getActiveSheet()->getPageSetup()
- ->setPaperSize(PHPExcel_Worksheet_PageSetup::PAPERSIZE_A4);
+$spreadsheet->getActiveSheet()->getPageSetup()
+ ->setOrientation(\PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::ORIENTATION_LANDSCAPE);
+$spreadsheet->getActiveSheet()->getPageSetup()
+ ->setPaperSize(\PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_A4);
```
Note that there are additional page settings available. Please refer to the API documentation for all possible options.
#### Page Setup: Scaling options
-The page setup scaling options in PHPExcel relate directly to the scaling options in the "Page Setup" dialog as shown in the illustration.
+The page setup scaling options in PhpSpreadsheet relate directly to the scaling options in the "Page Setup" dialog as shown in the illustration.
-Default values in PHPExcel correspond to default values in MS Office Excel as shown in illustration
+Default values in PhpSpreadsheet correspond to default values in MS Office Excel as shown in illustration
method | initial value | calling method will trigger | Note
--------------------|:-------------:|-----------------------------|------
- setFitToPage(...) | FALSE | - |
+ setFitToPage(...) | FALSE | - |
setScale(...) | 100 | setFitToPage(FALSE) |
setFitToWidth(...) | 1 | setFitToPage(TRUE) | value 0 means do-not-fit-to-width
setFitToHeight(...) | 1 | setFitToPage(TRUE) | value 0 means do-not-fit-to-height
@@ -275,23 +271,23 @@ Default values in PHPExcel correspond to default values in MS Office Excel as sh
Here is how to fit to 1 page wide by infinite pages tall:
```php
-$objPHPExcel->getActiveSheet()->getPageSetup()->setFitToWidth(1);
-$objPHPExcel->getActiveSheet()->getPageSetup()->setFitToHeight(0);
+$spreadsheet->getActiveSheet()->getPageSetup()->setFitToWidth(1);
+$spreadsheet->getActiveSheet()->getPageSetup()->setFitToHeight(0);
```
As you can see, it is not necessary to call setFitToPage(TRUE) since setFitToWidth(...) and setFitToHeight(...) triggers this.
-If you use setFitToWidth() you should in general also specify setFitToHeight() explicitly like in the example. Be careful relying on the initial values. This is especially true if you are upgrading from PHPExcel 1.7.0 to 1.7.1 where the default values for fit-to-height and fit-to-width changed from 0 to 1.
+If you use setFitToWidth() you should in general also specify setFitToHeight() explicitly like in the example. Be careful relying on the initial values.
#### Page margins
To set page margins for a worksheet, use this code:
```php
-$objPHPExcel->getActiveSheet()->getPageMargins()->setTop(1);
-$objPHPExcel->getActiveSheet()->getPageMargins()->setRight(0.75);
-$objPHPExcel->getActiveSheet()->getPageMargins()->setLeft(0.75);
-$objPHPExcel->getActiveSheet()->getPageMargins()->setBottom(1);
+$spreadsheet->getActiveSheet()->getPageMargins()->setTop(1);
+$spreadsheet->getActiveSheet()->getPageMargins()->setRight(0.75);
+$spreadsheet->getActiveSheet()->getPageMargins()->setLeft(0.75);
+$spreadsheet->getActiveSheet()->getPageMargins()->setBottom(1);
```
Note that the margin values are specified in inches.
@@ -303,8 +299,8 @@ Note that the margin values are specified in inches.
To center a page horizontally/vertically, you can use the following code:
```php
-$objPHPExcel->getActiveSheet()->getPageSetup()->setHorizontalCentered(true);
-$objPHPExcel->getActiveSheet()->getPageSetup()->setVerticalCentered(false);
+$spreadsheet->getActiveSheet()->getPageSetup()->setHorizontalCentered(true);
+$spreadsheet->getActiveSheet()->getPageSetup()->setVerticalCentered(false);
```
#### Setting the print header and footer of a worksheet
@@ -312,10 +308,10 @@ $objPHPExcel->getActiveSheet()->getPageSetup()->setVerticalCentered(false);
Setting a worksheet's print header and footer can be done using the following lines of code:
```php
-$objPHPExcel->getActiveSheet()->getHeaderFooter()
+$spreadsheet->getActiveSheet()->getHeaderFooter()
->setOddHeader('&C&HPlease treat this document as confidential!');
-$objPHPExcel->getActiveSheet()->getHeaderFooter()
- ->setOddFooter('&L&B' . $objPHPExcel->getProperties()->getTitle() . '&RPage &P of &N');
+$spreadsheet->getActiveSheet()->getHeaderFooter()
+ ->setOddFooter('&L&B' . $spreadsheet->getProperties()->getTitle() . '&RPage &P of &N');
```
Substitution and formatting codes (starting with &) can be used inside headers and footers. There is no required order in which these codes must appear.
@@ -364,20 +360,20 @@ Code | Meaning
[^print-footer-image-footnote]: z
```php
-$objDrawing = new PHPExcel_Worksheet_HeaderFooterDrawing();
-$objDrawing->setName('PHPExcel logo');
-$objDrawing->setPath('./images/phpexcel_logo.gif');
+$objDrawing = new \PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooterDrawing();
+$objDrawing->setName('PhpSpreadsheet logo');
+$objDrawing->setPath('./images/PhpSpreadsheet_logo.png');
$objDrawing->setHeight(36);
-$objPHPExcel->getActiveSheet()->getHeaderFooter()->addImage($objDrawing, PHPExcel_Worksheet_HeaderFooter::IMAGE_HEADER_LEFT);
+$spreadsheet->getActiveSheet()->getHeaderFooter()->addImage($objDrawing, \PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooter::IMAGE_HEADER_LEFT);
```
__Tip__
-The above table of codes may seem overwhelming first time you are trying to figure out how to write some header or footer. Luckily, there is an easier way. Let Microsoft Office Excel do the work for you.For example, create in Microsoft Office Excel an xlsx file where you insert the header and footer as desired using the programs own interface. Save file as test.xlsx. Now, take that file and read off the values using PHPExcel as follows:
+The above table of codes may seem overwhelming first time you are trying to figure out how to write some header or footer. Luckily, there is an easier way. Let Microsoft Office Excel do the work for you.For example, create in Microsoft Office Excel an xlsx file where you insert the header and footer as desired using the programs own interface. Save file as test.xlsx. Now, take that file and read off the values using PhpSpreadsheet as follows:
```php
-$objPHPexcel = PHPExcel_IOFactory::load('test.xlsx');
-$objWorksheet = $objPHPexcel->getActiveSheet();
+$spreadsheet = \PhpOffice\PhpSpreadsheet\IOFactory::load('test.xlsx');
+$objWorksheet = $spreadsheet->getActiveSheet();
var_dump($objWorksheet->getHeaderFooter()->getOddFooter());
var_dump($objWorksheet->getHeaderFooter()->getEvenFooter());
@@ -392,27 +388,27 @@ That reveals the codes for the even/odd header and footer. Experienced users may
To set a print break, use the following code, which sets a row break on row 10.
```php
-$objPHPExcel->getActiveSheet()->setBreak( 'A10' , PHPExcel_Worksheet::BREAK_ROW );
+$spreadsheet->getActiveSheet()->setBreak( 'A10' , \PhpOffice\PhpSpreadsheet\Worksheet::BREAK_ROW );
```
The following line of code sets a print break on column D:
```php
-$objPHPExcel->getActiveSheet()->setBreak( 'D10' , PHPExcel_Worksheet::BREAK_COLUMN );
+$spreadsheet->getActiveSheet()->setBreak( 'D10' , \PhpOffice\PhpSpreadsheet\Worksheet::BREAK_COLUMN );
```
#### Show/hide gridlines when printing
To show/hide gridlines when printing, use the following code:
-$objPHPExcel->getActiveSheet()->setShowGridlines(true);
+$spreadsheet->getActiveSheet()->setShowGridlines(true);
#### Setting rows/columns to repeat at top/left
-PHPExcel 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:
+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
-$objPHPExcel->getActiveSheet()->getPageSetup()->setRowsToRepeatAtTopByStartAndEnd(1, 5);
+$spreadsheet->getActiveSheet()->getPageSetup()->setRowsToRepeatAtTopByStartAndEnd(1, 5);
```
#### Specify printing area
@@ -420,13 +416,13 @@ $objPHPExcel->getActiveSheet()->getPageSetup()->setRowsToRepeatAtTopByStartAndEn
To specify a worksheet's printing area, use the following code:
```php
-$objPHPExcel->getActiveSheet()->getPageSetup()->setPrintArea('A1:E5');
+$spreadsheet->getActiveSheet()->getPageSetup()->setPrintArea('A1:E5');
```
There can also be multiple printing areas in a single worksheet:
```php
-$objPHPExcel->getActiveSheet()->getPageSetup()->setPrintArea('A1:E5,G4:M20');
+$spreadsheet->getActiveSheet()->getPageSetup()->setPrintArea('A1:E5,G4:M20');
```
### Styles
@@ -436,29 +432,29 @@ $objPHPExcel->getActiveSheet()->getPageSetup()->setPrintArea('A1:E5,G4:M20');
A cell can be formatted with font, border, fill, ... style information. 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
-$objPHPExcel->getActiveSheet()->getStyle('B2')
- ->getFont()->getColor()->setARGB(PHPExcel_Style_Color::COLOR_RED);
-$objPHPExcel->getActiveSheet()->getStyle('B2')
- ->getAlignment()->setHorizontal(PHPExcel_Style_Alignment::HORIZONTAL_RIGHT);
-$objPHPExcel->getActiveSheet()->getStyle('B2')
- ->getBorders()->getTop()->setBorderStyle(PHPExcel_Style_Border::BORDER_THICK);
-$objPHPExcel->getActiveSheet()->getStyle('B2')
- ->getBorders()->getBottom()->setBorderStyle(PHPExcel_Style_Border::BORDER_THICK);
-$objPHPExcel->getActiveSheet()->getStyle('B2')
- ->getBorders()->getLeft()->setBorderStyle(PHPExcel_Style_Border::BORDER_THICK);
-$objPHPExcel->getActiveSheet()->getStyle('B2')
- ->getBorders()->getRight()->setBorderStyle(PHPExcel_Style_Border::BORDER_THICK);
-$objPHPExcel->getActiveSheet()->getStyle('B2')
- ->getFill()->setFillType(PHPExcel_Style_Fill::FILL_SOLID);
-$objPHPExcel->getActiveSheet()->getStyle('B2')
+$spreadsheet->getActiveSheet()->getStyle('B2')
+ ->getFont()->getColor()->setARGB(\PhpOffice\PhpSpreadsheet\Style\Color::COLOR_RED);
+$spreadsheet->getActiveSheet()->getStyle('B2')
+ ->getAlignment()->setHorizontal(\PhpOffice\PhpSpreadsheet\Style\Alignment::HORIZONTAL_RIGHT);
+$spreadsheet->getActiveSheet()->getStyle('B2')
+ ->getBorders()->getTop()->setBorderStyle(\PhpOffice\PhpSpreadsheet\Style\Border::BORDER_THICK);
+$spreadsheet->getActiveSheet()->getStyle('B2')
+ ->getBorders()->getBottom()->setBorderStyle(\PhpOffice\PhpSpreadsheet\Style\Border::BORDER_THICK);
+$spreadsheet->getActiveSheet()->getStyle('B2')
+ ->getBorders()->getLeft()->setBorderStyle(\PhpOffice\PhpSpreadsheet\Style\Border::BORDER_THICK);
+$spreadsheet->getActiveSheet()->getStyle('B2')
+ ->getBorders()->getRight()->setBorderStyle(\PhpOffice\PhpSpreadsheet\Style\Border::BORDER_THICK);
+$spreadsheet->getActiveSheet()->getStyle('B2')
+ ->getFill()->setFillType(\PhpOffice\PhpSpreadsheet\Style\Fill::FILL_SOLID);
+$spreadsheet->getActiveSheet()->getStyle('B2')
->getFill()->getStartColor()->setARGB('FFFF0000');
```
-Starting with PHPExcel 1.7.0 getStyle() also accepts a cell range as a parameter. For example, you can set a red background color on a range of cells:
+`getStyle()` also accepts a cell range as a parameter. For example, you can set a red background color on a range of cells:
```php
-$objPHPExcel->getActiveSheet()->getStyle('B3:B7')->getFill()
- ->setFillType(PHPExcel_Style_Fill::FILL_SOLID)
+$spreadsheet->getActiveSheet()->getStyle('B3:B7')->getFill()
+ ->setFillType(\PhpOffice\PhpSpreadsheet\Style\Fill::FILL_SOLID)
->getStartColor()->setARGB('FFFF0000');
```
@@ -473,15 +469,15 @@ $styleArray = array(
'bold' => true,
),
'alignment' => array(
- 'horizontal' => PHPExcel_Style_Alignment::HORIZONTAL_RIGHT,
+ 'horizontal' => \PhpOffice\PhpSpreadsheet\Style\Alignment::HORIZONTAL_RIGHT,
),
'borders' => array(
'top' => array(
- 'style' => PHPExcel_Style_Border::BORDER_THIN,
+ 'style' => \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_THIN,
),
),
'fill' => array(
- 'type' => PHPExcel_Style_Fill::FILL_GRADIENT_LINEAR,
+ 'type' => \PhpOffice\PhpSpreadsheet\Style\Fill::FILL_GRADIENT_LINEAR,
'rotation' => 90,
'startcolor' => array(
'argb' => 'FFA0A0A0',
@@ -492,13 +488,13 @@ $styleArray = array(
),
);
-$objPHPExcel->getActiveSheet()->getStyle('A3')->applyFromArray($styleArray);
+$spreadsheet->getActiveSheet()->getStyle('A3')->applyFromArray($styleArray);
```
Or with a range of cells:
```php
-$objPHPExcel->getActiveSheet()->getStyle('B3:B7')->applyFromArray($styleArray);
+$spreadsheet->getActiveSheet()->getStyle('B3:B7')->applyFromArray($styleArray);
```
This alternative method using arrays should be faster in terms of 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.
@@ -511,11 +507,11 @@ You often want to format numbers in Excel. For example you may want a thousands
In Microsoft Office Excel you may be familiar with selecting a number format from the "Format Cells" dialog. Here there are some predefined number formats available including some for dates. The dialog is designed in a way so you don't have to interact with the underlying raw number format code unless you need a custom number format.
-In PHPExcel, you can also apply various predefined number formats. Example:
+In PhpSpreadsheet, you can also apply various predefined number formats. Example:
```php
-$objPHPExcel->getActiveSheet()->getStyle('A1')->getNumberFormat()
- ->setFormatCode(PHPExcel_Style_NumberFormat::FORMAT_NUMBER_COMMA_SEPARATED1);
+$spreadsheet->getActiveSheet()->getStyle('A1')->getNumberFormat()
+ ->setFormatCode(\PhpOffice\PhpSpreadsheet\Style\NumberFormat::FORMAT_NUMBER_COMMA_SEPARATED1);
```
This will format a number e.g. 1587.2 so it shows up as 1,587.20 when you open the workbook in MS Office Excel. (Depending on settings for decimal and thousands separators in Microsoft Office Excel it may show up as 1.587,20)
@@ -523,34 +519,34 @@ This will format a number e.g. 1587.2 so it shows up as 1,587.20 when you open t
You can achieve exactly the same as the above by using this:
```php
-$objPHPExcel->getActiveSheet()->getStyle('A1')->getNumberFormat()
+$spreadsheet->getActiveSheet()->getStyle('A1')->getNumberFormat()
->setFormatCode('#,##0.00');
```
-In Microsoft Office Excel, as well as in PHPExcel, you will have to interact with raw number format codes whenever you need some special custom number format. Example:
+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
-$objPHPExcel->getActiveSheet()->getStyle('A1')->getNumberFormat()
+$spreadsheet->getActiveSheet()->getStyle('A1')->getNumberFormat()
->setFormatCode('[Blue][>=3000]$#,##0;[Red][<0]$#,##0;$#,##0');
```
Another example is when you want numbers zero-padded with leading zeros to a fixed length:
```php
-$objPHPExcel->getActiveSheet()->getCell('A1')->setValue(19);
-$objPHPExcel->getActiveSheet()->getStyle('A1')->getNumberFormat()
+$spreadsheet->getActiveSheet()->getCell('A1')->setValue(19);
+$spreadsheet->getActiveSheet()->getStyle('A1')->getNumberFormat()
->setFormatCode('0000'); // will show as 0019 in Excel
```
__Tip__
The rules for composing a number format code in Excel can be rather complicated. Sometimes you know how to create some number format in Microsoft Office Excel, but don't know what the underlying number format code looks like. How do you find it?
-The readers shipped with PHPExcel 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:
+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
-$objReader = PHPExcel_IOFactory::createReader('Xlsx');
-$objPHPExcel = $objReader->load('template.xlsx');
-var_dump($objPHPExcel->getActiveSheet()->getStyle('A1')->getNumberFormat()->getFormatCode());
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader('Xlsx');
+$spreadsheet = $objReader->load('template.xlsx');
+var_dump($spreadsheet->getActiveSheet()->getStyle('A1')->getNumberFormat()->getFormatCode());
```
Advanced users may find it faster to inspect the number format code directly by renaming template.xlsx to template.zip, unzipping, and looking for the relevant piece of XML code holding the number format code in *xl/styles.xml*.
@@ -560,14 +556,14 @@ Advanced users may find it faster to inspect the number format code directly by
Let's set vertical alignment to the top for cells A1:D4
```php
-$objPHPExcel->getActiveSheet()->getStyle('A1:D4')
- ->getAlignment()->setVertical(PHPExcel_Style_Alignment::VERTICAL_TOP);
+$spreadsheet->getActiveSheet()->getStyle('A1:D4')
+ ->getAlignment()->setVertical(\PhpOffice\PhpSpreadsheet\Style\Alignment::VERTICAL_TOP);
```
Here is how to achieve wrap text:
```php
-$objPHPExcel->getActiveSheet()->getStyle('A1:D4')
+$spreadsheet->getActiveSheet()->getStyle('A1:D4')
->getAlignment()->setWrapText(true);
```
@@ -576,19 +572,19 @@ $objPHPExcel->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
-$objPHPExcel->getDefaultStyle()->getFont()->setName('Arial');
-$objPHPExcel->getDefaultStyle()->getFont()->setSize(8);
+$spreadsheet->getDefaultStyle()->getFont()->setName('Arial');
+$spreadsheet->getDefaultStyle()->getFont()->setSize(8);
```
#### Styling cell borders
-In PHPExcel 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.
+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
$styleArray = array(
'borders' => array(
'outline' => array(
- 'style' => PHPExcel_Style_Border::BORDER_THICK,
+ 'style' => \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_THICK,
'color' => array('argb' => 'FFFF0000'),
),
),
@@ -627,7 +623,7 @@ An overview of all border shortcuts can be seen in the following image:
-If you simultaneously set e.g. allborders and vertical, then we have "overlapping" borders, and one of the components has to win over the other where there is border overlap. In PHPExcel, from weakest to strongest borders, the list is as follows: allborders, outline/inside, vertical/horizontal, left/right/top/bottom/diagonal.
+If you simultaneously set e.g. allborders and vertical, then we have "overlapping" borders, and one of the components has to win over the other where there is border overlap. In PhpSpreadsheet, from weakest to strongest borders, the list is as follows: allborders, outline/inside, vertical/horizontal, left/right/top/bottom/diagonal.
This border hierarchy can be utilized to achieve various effects in an easy manner.
@@ -638,34 +634,34 @@ A cell can be formatted conditionally, based on a specific rule. For example, on
One can set a conditional style ruleset to a cell using the following code:
```php
-$objConditional1 = new PHPExcel_Style_Conditional();
-$objConditional1->setConditionType(PHPExcel_Style_Conditional::CONDITION_CELLIS);
-$objConditional1->setOperatorType(PHPExcel_Style_Conditional::OPERATOR_LESSTHAN);
+$objConditional1 = new \PhpOffice\PhpSpreadsheet\Style\Conditional();
+$objConditional1->setConditionType(\PhpOffice\PhpSpreadsheet\Style\Conditional::CONDITION_CELLIS);
+$objConditional1->setOperatorType(\PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_LESSTHAN);
$objConditional1->addCondition('0');
-$objConditional1->getStyle()->getFont()->getColor()->setARGB(PHPExcel_Style_Color::COLOR_RED);
+$objConditional1->getStyle()->getFont()->getColor()->setARGB(\PhpOffice\PhpSpreadsheet\Style\Color::COLOR_RED);
$objConditional1->getStyle()->getFont()->setBold(true);
-$objConditional2 = new PHPExcel_Style_Conditional();
-$objConditional2->setConditionType(PHPExcel_Style_Conditional::CONDITION_CELLIS);
-$objConditional2->setOperatorType(PHPExcel_Style_Conditional::OPERATOR_GREATERTHANOREQUAL);
+$objConditional2 = new \PhpOffice\PhpSpreadsheet\Style\Conditional();
+$objConditional2->setConditionType(\PhpOffice\PhpSpreadsheet\Style\Conditional::CONDITION_CELLIS);
+$objConditional2->setOperatorType(\PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_GREATERTHANOREQUAL);
$objConditional2->addCondition('0');
-$objConditional2->getStyle()->getFont()->getColor()->setARGB(PHPExcel_Style_Color::COLOR_GREEN);
+$objConditional2->getStyle()->getFont()->getColor()->setARGB(\PhpOffice\PhpSpreadsheet\Style\Color::COLOR_GREEN);
$objConditional2->getStyle()->getFont()->setBold(true);
-$conditionalStyles = $objPHPExcel->getActiveSheet()->getStyle('B2')->getConditionalStyles();
+$conditionalStyles = $spreadsheet->getActiveSheet()->getStyle('B2')->getConditionalStyles();
array_push($conditionalStyles, $objConditional1);
array_push($conditionalStyles, $objConditional2);
-$objPHPExcel->getActiveSheet()->getStyle('B2')->setConditionalStyles($conditionalStyles);
+$spreadsheet->getActiveSheet()->getStyle('B2')->setConditionalStyles($conditionalStyles);
```
If you want to copy the ruleset to other cells, you can duplicate the style object:
```php
-$objPHPExcel->getActiveSheet()
+$spreadsheet->getActiveSheet()
->duplicateStyle(
- $objPHPExcel->getActiveSheet()->getStyle('B2'),
- 'B3:B7'
+ $spreadsheet->getActiveSheet()->getStyle('B2'),
+ 'B3:B7'
);
```
@@ -674,17 +670,17 @@ $objPHPExcel->getActiveSheet()
To add a comment to a cell, use the following code. The example below adds a comment to cell E11:
```php
-$objPHPExcel->getActiveSheet()
+$spreadsheet->getActiveSheet()
->getComment('E11')
->setAuthor('Mark Baker');
-$objCommentRichText = $objPHPExcel->getActiveSheet()
+$objCommentRichText = $spreadsheet->getActiveSheet()
->getComment('E11')
- ->getText()->createTextRun('PHPExcel:');
+ ->getText()->createTextRun('PhpSpreadsheet:');
$objCommentRichText->getFont()->setBold(true);
-$objPHPExcel->getActiveSheet()
+$spreadsheet->getActiveSheet()
->getComment('E11')
->getText()->createTextRun("\r\n");
-$objPHPExcel->getActiveSheet()
+$spreadsheet->getActiveSheet()
->getComment('E11')
->getText()->createTextRun('Total amount on the current invoice, excluding VAT.');
```
@@ -696,7 +692,7 @@ $objPHPExcel->getActiveSheet()
To apply an autofilter to a range of cells, use the following code:
```php
-$objPHPExcel->getActiveSheet()->setAutoFilter('A1:C9');
+$spreadsheet->getActiveSheet()->setAutoFilter('A1:C9');
```
__Make sure that you always include the complete filter range!__
@@ -709,38 +705,38 @@ Excel offers 3 levels of "protection": document security, sheet security and cel
Document security allows you to set a password on a complete spreadsheet, allowing changes to be made only when that password is entered.Worksheet security offers other security options: you can disallow inserting rows on a specific sheet, disallow sorting, ... Cell security offers the option to lock/unlock a cell as well as show/hide the internal formulaAn example on setting document security:
```php
-$objPHPExcel->getSecurity()->setLockWindows(true);
-$objPHPExcel->getSecurity()->setLockStructure(true);
-$objPHPExcel->getSecurity()->setWorkbookPassword("PHPExcel");
+$spreadsheet->getSecurity()->setLockWindows(true);
+$spreadsheet->getSecurity()->setLockStructure(true);
+$spreadsheet->getSecurity()->setWorkbookPassword("PhpSpreadsheet");
```
An example on setting worksheet security:
```php
-$objPHPExcel->getActiveSheet()
- ->getProtection()->setPassword('PHPExcel');
-$objPHPExcel->getActiveSheet()
+$spreadsheet->getActiveSheet()
+ ->getProtection()->setPassword('PhpSpreadsheet');
+$spreadsheet->getActiveSheet()
->getProtection()->setSheet(true);
-$objPHPExcel->getActiveSheet()
+$spreadsheet->getActiveSheet()
->getProtection()->setSort(true);
-$objPHPExcel->getActiveSheet()
+$spreadsheet->getActiveSheet()
->getProtection()->setInsertRows(true);
-$objPHPExcel->getActiveSheet()
+$spreadsheet->getActiveSheet()
->getProtection()->setFormatCells(true);
```
An example on setting cell security:
```php
-$objPHPExcel->getActiveSheet()->getStyle('B1')
+$spreadsheet->getActiveSheet()->getStyle('B1')
->getProtection()
- ->setLocked(PHPExcel_Style_Protection::PROTECTION_UNPROTECTED);
+ ->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:
```php
-$objPHPExcel->getActiveSheet()->getProtection()->setSheet(true);
+$spreadsheet->getActiveSheet()->getProtection()->setSheet(true);
```
### Setting data validation on a cell
@@ -750,10 +746,10 @@ Data validation is a powerful feature of Xlsx. It allows to specify an input fil
The following piece of code only allows numbers between 10 and 20 to be entered in cell B3:
```php
-$objValidation = $objPHPExcel->getActiveSheet()->getCell('B3')
+$objValidation = $spreadsheet->getActiveSheet()->getCell('B3')
->getDataValidation();
-$objValidation->setType( PHPExcel_Cell_DataValidation::TYPE_WHOLE );
-$objValidation->setErrorStyle( PHPExcel_Cell_DataValidation::STYLE_STOP );
+$objValidation->setType( \PhpOffice\PhpSpreadsheet\Cell\DataValidation::TYPE_WHOLE );
+$objValidation->setErrorStyle( \PhpOffice\PhpSpreadsheet\Cell\DataValidation::STYLE_STOP );
$objValidation->setAllowBlank(true);
$objValidation->setShowInputMessage(true);
$objValidation->setShowErrorMessage(true);
@@ -768,10 +764,10 @@ $objValidation->setFormula2(20);
The following piece of code only allows an item picked from a list of data to be entered in cell B3:
```php
-$objValidation = $objPHPExcel->getActiveSheet()->getCell('B5')
+$objValidation = $spreadsheet->getActiveSheet()->getCell('B5')
->getDataValidation();
-$objValidation->setType( PHPExcel_Cell_DataValidation::TYPE_LIST );
-$objValidation->setErrorStyle( PHPExcel_Cell_DataValidation::STYLE_INFORMATION );
+$objValidation->setType( \PhpOffice\PhpSpreadsheet\Cell\DataValidation::TYPE_LIST );
+$objValidation->setErrorStyle( \PhpOffice\PhpSpreadsheet\Cell\DataValidation::STYLE_INFORMATION );
$objValidation->setAllowBlank(false);
$objValidation->setShowInputMessage(true);
$objValidation->setShowErrorMessage(true);
@@ -790,7 +786,7 @@ It is important to remember that any string participating in an Excel formula is
If you need data validation on multiple cells, one can clone the ruleset:
```php
-$objPHPExcel->getActiveSheet()->getCell('B8')->setDataValidation(clone $objValidation);
+$spreadsheet->getActiveSheet()->getCell('B8')->setDataValidation(clone $objValidation);
```
### Setting a column's width
@@ -798,26 +794,26 @@ $objPHPExcel->getActiveSheet()->getCell('B8')->setDataValidation(clone $objValid
A column's width can be set using the following code:
```php
-$objPHPExcel->getActiveSheet()->getColumnDimension('D')->setWidth(12);
+$spreadsheet->getActiveSheet()->getColumnDimension('D')->setWidth(12);
```
-If you want PHPExcel to perform an automatic width calculation, use the following code. PHPExcel will approximate the column with to the width of the widest column value.
+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
-$objPHPExcel->getActiveSheet()->getColumnDimension('B')->setAutoSize(true);
+$spreadsheet->getActiveSheet()->getColumnDimension('B')->setAutoSize(true);
```
-The measure for column width in PHPExcel does __not__ correspond exactly to the measure you may be used to in Microsoft Office Excel. Column widths are difficult to deal with in Excel, and there are several measures for the column width.1) __Inner width in character units__ (e.g. 8.43 this is probably what you are familiar with in Excel)2) __Full width in pixels__ (e.g. 64 pixels)3) __Full width in character units__ (e.g. 9.140625, value -1 indicates unset width)__PHPExcel always operates with 3) "Full width in character units"__ which is in fact the only value that is stored in any Excel file, hence the most reliable measure. Unfortunately, __Microsoft ____Office ____Excel does not present you with this ____measure__. Instead measures 1) and 2) are computed by the application when the file is opened and these values are presented in various dialogues and tool tips.The character width unit is the width of a '0' (zero) glyph in the workbooks default font. Therefore column widths measured in character units in two different workbooks can only be compared if they have the same default workbook font.If you have some Excel file and need to know the column widths in measure 3), you can read the Excel file with PHPExcel and echo the retrieved values.
+The measure for column width in PhpSpreadsheet does __not__ correspond exactly to the measure you may be used to in Microsoft Office Excel. Column widths are difficult to deal with in Excel, and there are several measures for the column width.1) __Inner width in character units__ (e.g. 8.43 this is probably what you are familiar with in Excel)2) __Full width in pixels__ (e.g. 64 pixels)3) __Full width in character units__ (e.g. 9.140625, value -1 indicates unset width)__PHPExcel always operates with 3) "Full width in character units"__ which is in fact the only value that is stored in any Excel file, hence the most reliable measure. Unfortunately, __Microsoft ____Office ____Excel does not present you with this ____measure__. Instead measures 1) and 2) are computed by the application when the file is opened and these values are presented in various dialogues and tool tips.The character width unit is the width of a '0' (zero) glyph in the workbooks default font. Therefore column widths measured in character units in two different workbooks can only be compared if they have the same default workbook font.If you have some Excel file and need to know the column widths in measure 3), you can read the Excel file with PhpSpreadsheet and echo the retrieved values.
### Show/hide a column
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
-$objPHPExcel->getActiveSheet()->getColumnDimension('C')->setVisible(true);
-$objPHPExcel->getActiveSheet()->getColumnDimension('D')->setVisible(false);
+$spreadsheet->getActiveSheet()->getColumnDimension('C')->setVisible(true);
+$spreadsheet->getActiveSheet()->getColumnDimension('D')->setVisible(false);
```
### Group/outline a column
@@ -825,22 +821,22 @@ $objPHPExcel->getActiveSheet()->getColumnDimension('D')->setVisible(false);
To group/outline a column, you can use the following code:
```php
-$objPHPExcel->getActiveSheet()->getColumnDimension('E')->setOutlineLevel(1);
+$spreadsheet->getActiveSheet()->getColumnDimension('E')->setOutlineLevel(1);
```
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
-$objPHPExcel->getActiveSheet()->getColumnDimension('E')->setCollapsed(true);
-$objPHPExcel->getActiveSheet()->getColumnDimension('E')->setVisible(false);
+$spreadsheet->getActiveSheet()->getColumnDimension('E')->setCollapsed(true);
+$spreadsheet->getActiveSheet()->getColumnDimension('E')->setVisible(false);
```
Please refer to the section "group/outline a row" for a complete example on collapsing.
-You can instruct PHPExcel to add a summary to the right (default), or to the left. The following code adds the summary to the left:
+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
-$objPHPExcel->getActiveSheet()->setShowSummaryRight(false);
+$spreadsheet->getActiveSheet()->setShowSummaryRight(false);
```
### Setting a row's height
@@ -848,7 +844,7 @@ $objPHPExcel->getActiveSheet()->setShowSummaryRight(false);
A row's height can be set using the following code:
```php
-$objPHPExcel->getActiveSheet()->getRowDimension('10')->setRowHeight(100);
+$spreadsheet->getActiveSheet()->getRowDimension('10')->setRowHeight(100);
```
Excel measures row height in points, where 1 pt is 1/72 of an inch (or about 0.35mm). The default value is 12.75 pts; and the permitted range of values is between 0 and 409 pts, where 0 pts is a hidden row.
@@ -858,7 +854,7 @@ Excel measures row height in points, where 1 pt is 1/72 of an inch (or about 0.3
To set a worksheet''s row visibility, you can use the following code. The following example hides row number 10.
```php
-$objPHPExcel->getActiveSheet()->getRowDimension('10')->setVisible(false);
+$spreadsheet->getActiveSheet()->getRowDimension('10')->setVisible(false);
```
Note that if you apply active filters using an AutoFilter, then this will override any rows that you hide or unhide manually within that AutoFilter range if you save the file.
@@ -868,36 +864,36 @@ Note that if you apply active filters using an AutoFilter, then this will overri
To group/outline a row, you can use the following code:
```php
-$objPHPExcel->getActiveSheet()->getRowDimension('5')->setOutlineLevel(1);
+$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
-$objPHPExcel->getActiveSheet()->getRowDimension('5')->setCollapsed(true);
-$objPHPExcel->getActiveSheet()->getRowDimension('5')->setVisible(false);
+$spreadsheet->getActiveSheet()->getRowDimension('5')->setCollapsed(true);
+$spreadsheet->getActiveSheet()->getRowDimension('5')->setVisible(false);
```
Here's an example which collapses rows 50 to 80:
```php
for ($i = 51; $i <= 80; $i++) {
- $objPHPExcel->getActiveSheet()->setCellValue('A' . $i, "FName $i");
- $objPHPExcel->getActiveSheet()->setCellValue('B' . $i, "LName $i");
- $objPHPExcel->getActiveSheet()->setCellValue('C' . $i, "PhoneNo $i");
- $objPHPExcel->getActiveSheet()->setCellValue('D' . $i, "FaxNo $i");
- $objPHPExcel->getActiveSheet()->setCellValue('E' . $i, true);
- $objPHPExcel->getActiveSheet()->getRowDimension($i)->setOutlineLevel(1);
- $objPHPExcel->getActiveSheet()->getRowDimension($i)->setVisible(false);
+ $spreadsheet->getActiveSheet()->setCellValue('A' . $i, "FName $i");
+ $spreadsheet->getActiveSheet()->setCellValue('B' . $i, "LName $i");
+ $spreadsheet->getActiveSheet()->setCellValue('C' . $i, "PhoneNo $i");
+ $spreadsheet->getActiveSheet()->setCellValue('D' . $i, "FaxNo $i");
+ $spreadsheet->getActiveSheet()->setCellValue('E' . $i, true);
+ $spreadsheet->getActiveSheet()->getRowDimension($i)->setOutlineLevel(1);
+ $spreadsheet->getActiveSheet()->getRowDimension($i)->setVisible(false);
}
-$objPHPExcel->getActiveSheet()->getRowDimension(81)->setCollapsed(true);
+$spreadsheet->getActiveSheet()->getRowDimension(81)->setCollapsed(true);
```
-You can instruct PHPExcel to add a summary below the collapsible rows (default), or above. The following code adds the summary above:
+You can instruct PhpSpreadsheet to add a summary below the collapsible rows (default), or above. The following code adds the summary above:
```php
-$objPHPExcel->getActiveSheet()->setShowSummaryBelow(false);
+$spreadsheet->getActiveSheet()->setShowSummaryBelow(false);
```
### Merge/unmerge cells
@@ -905,13 +901,13 @@ $objPHPExcel->getActiveSheet()->setShowSummaryBelow(false);
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
-$objPHPExcel->getActiveSheet()->mergeCells('A18:E22');
+$spreadsheet->getActiveSheet()->mergeCells('A18:E22');
```
Removing a merge can be done using the unmergeCells method:
```php
-$objPHPExcel->getActiveSheet()->unmergeCells('A18:E22');
+$spreadsheet->getActiveSheet()->unmergeCells('A18:E22');
```
### Inserting rows/columns
@@ -919,25 +915,25 @@ $objPHPExcel->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
-$objPHPExcel->getActiveSheet()->insertNewRowBefore(7, 2);
+$spreadsheet->getActiveSheet()->insertNewRowBefore(7, 2);
```
### Add a drawing to a worksheet
-A drawing is always represented as a separate object, which can be added to a worksheet. Therefore, you must first instantiate a new PHPExcel_Worksheet_Drawing, and assign its properties a meaningful value:
+A drawing is always represented as a separate object, which can be added to a worksheet. Therefore, you must first instantiate a new \PhpOffice\PhpSpreadsheet\Worksheet\Drawing, and assign its properties a meaningful value:
```php
-$objDrawing = new PHPExcel_Worksheet_Drawing();
+$objDrawing = new \PhpOffice\PhpSpreadsheet\Worksheet\Drawing();
$objDrawing->setName('Logo');
$objDrawing->setDescription('Logo');
$objDrawing->setPath('./images/officelogo.jpg');
$objDrawing->setHeight(36);
```
-To add the above drawing to the worksheet, use the following snippet of code. PHPExcel creates the link between the drawing and the worksheet:
+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
-$objDrawing->setWorksheet($objPHPExcel->getActiveSheet());
+$objDrawing->setWorksheet($spreadsheet->getActiveSheet());
```
You can set numerous properties on a drawing, here are some examples:
@@ -959,20 +955,20 @@ You can also add images created using GD functions without needing to save them
// 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);
-imagestring($gdImage, 1, 5, 5, 'Created with PHPExcel', $textColor);
+imagestring($gdImage, 1, 5, 5, 'Created with PhpSpreadsheet', $textColor);
// Add the In-Memory image to a worksheet
-$objDrawing = new PHPExcel_Worksheet_MemoryDrawing();
+$objDrawing = new \PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing();
$objDrawing->setName('In-Memory image 1');
$objDrawing->setDescription('In-Memory image 1');
$objDrawing->setCoordinates('A1');
$objDrawing->setImageResource($gdImage);
$objDrawing->setRenderingFunction(
- PHPExcel_Worksheet_MemoryDrawing::RENDERING_JPEG
+ \PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing::RENDERING_JPEG
);
-$objDrawing->setMimeType(PHPExcel_Worksheet_MemoryDrawing::MIMETYPE_DEFAULT);
+$objDrawing->setMimeType(\PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing::MIMETYPE_DEFAULT);
$objDrawing->setHeight(36);
-$objDrawing->setWorksheet($objPHPExcel->getActiveSheet());
+$objDrawing->setWorksheet($spreadsheet->getActiveSheet());
```
### Reading Images from a worksheet
@@ -983,8 +979,8 @@ The following code extracts images from the current active worksheet, and writes
```php
$i = 0;
-foreach ($objPHPExcel->getActiveSheet()->getDrawingCollection() as $drawing) {
- if ($drawing instanceof PHPExcel_Worksheet_MemoryDrawing) {
+foreach ($spreadsheet->getActiveSheet()->getDrawingCollection() as $drawing) {
+ if ($drawing instanceof \PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing) {
ob_start();
call_user_func(
$drawing->getRenderingFunction(),
@@ -993,14 +989,14 @@ foreach ($objPHPExcel->getActiveSheet()->getDrawingCollection() as $drawing) {
$imageContents = ob_get_contents();
ob_end_clean();
switch ($drawing->getMimeType()) {
- case PHPExcel_Worksheet_MemoryDrawing::MIMETYPE_PNG :
- $extension = 'png';
+ case \PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing::MIMETYPE_PNG :
+ $extension = 'png';
break;
- case PHPExcel_Worksheet_MemoryDrawing::MIMETYPE_GIF:
- $extension = 'gif';
+ case \PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing::MIMETYPE_GIF:
+ $extension = 'gif';
break;
- case PHPExcel_Worksheet_MemoryDrawing::MIMETYPE_JPEG :
- $extension = 'jpg';
+ case \PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing::MIMETYPE_JPEG :
+ $extension = 'jpg';
break;
}
} else {
@@ -1019,36 +1015,36 @@ foreach ($objPHPExcel->getActiveSheet()->getDrawingCollection() as $drawing) {
### Add rich text to a cell
-Adding rich text to a cell can be done using PHPExcel_RichText instances. Here''s an example, which creates the following rich text string:
+Adding rich text to a cell can be done using \PhpOffice\PhpSpreadsheet\RichText instances. Here''s an example, which 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
-$objRichText = new PHPExcel_RichText();
+$objRichText = new \PhpOffice\PhpSpreadsheet\RichText();
$objRichText->createText('This invoice is ');
$objPayable = $objRichText->createTextRun('payable within thirty days after the end of the month');
$objPayable->getFont()->setBold(true);
$objPayable->getFont()->setItalic(true);
-$objPayable->getFont()->setColor( new PHPExcel_Style_Color( PHPExcel_Style_Color::COLOR_DARKGREEN ) );
+$objPayable->getFont()->setColor( new \PhpOffice\PhpSpreadsheet\Style\Color( \PhpOffice\PhpSpreadsheet\Style\Color::COLOR_DARKGREEN ) );
$objRichText->createText(', unless specified otherwise on the invoice.');
-$objPHPExcel->getActiveSheet()->getCell('A18')->setValue($objRichText);
+$spreadsheet->getActiveSheet()->getCell('A18')->setValue($objRichText);
```
### Define a named range
-PHPExcel supports the definition of named ranges. These can be defined using the following code:
+PhpSpreadsheet supports the definition of named ranges. These can be defined using the following code:
```php
// Add some data
-$objPHPExcel->setActiveSheetIndex(0);
-$objPHPExcel->getActiveSheet()->setCellValue('A1', 'Firstname:');
-$objPHPExcel->getActiveSheet()->setCellValue('A2', 'Lastname:');
-$objPHPExcel->getActiveSheet()->setCellValue('B1', 'Maarten');
-$objPHPExcel->getActiveSheet()->setCellValue('B2', 'Balliauw');
+$spreadsheet->setActiveSheetIndex(0);
+$spreadsheet->getActiveSheet()->setCellValue('A1', 'Firstname:');
+$spreadsheet->getActiveSheet()->setCellValue('A2', 'Lastname:');
+$spreadsheet->getActiveSheet()->setCellValue('B1', 'Maarten');
+$spreadsheet->getActiveSheet()->setCellValue('B2', 'Balliauw');
// Define named ranges
-$objPHPExcel->addNamedRange( new PHPExcel_NamedRange('PersonFN', $objPHPExcel->getActiveSheet(), 'B1') );
-$objPHPExcel->addNamedRange( new PHPExcel_NamedRange('PersonLN', $objPHPExcel->getActiveSheet(), 'B2') );
+$spreadsheet->addNamedRange( new \PhpOffice\PhpSpreadsheet\NamedRange('PersonFN', $spreadsheet->getActiveSheet(), 'B1') );
+$spreadsheet->addNamedRange( new \PhpOffice\PhpSpreadsheet\NamedRange('PersonLN', $spreadsheet->getActiveSheet(), 'B2') );
```
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.
@@ -1057,13 +1053,13 @@ Optionally, a fourth parameter can be passed defining the named range local (i.e
Sometimes, one really wants to output a file to a client''s browser, especially when creating spreadsheets on-the-fly. There are some easy steps that can be followed to do this:
- 1. Create your PHPExcel spreadsheet
+ 1. Create your PhpSpreadsheet spreadsheet
2. Output HTTP headers for the type of document you wish to output
- 3. Use the PHPExcel_Writer_* of your choice, and save to "php://output"
+ 3. Use the PHPExcel_Writer_* of your choice, and save to "php://output"
-PHPExcel_Writer_Excel2007 uses temporary storage when writing to php://output. By default, temporary files are stored in the script's working directory. When there is no access, it falls back to the operating system's temporary files location.
+\PhpOffice\PhpSpreadsheet\Writer\Xlsx uses temporary storage when writing to php://output. By default, temporary files are stored in the script's working directory. When there is no access, it falls back to the operating system's temporary files location.
-__This may not be safe for unauthorized viewing!__
+__This may not be safe for unauthorized viewing!__
Depending on the configuration of your operating system, temporary storage can be read by anyone using the same temporary storage folder. When confidentiality of your document is needed, it is recommended not to use php://output.
#### HTTP headers
@@ -1071,34 +1067,34 @@ Depending on the configuration of your operating system, temporary storage can b
Example of a script redirecting an Excel 2007 file to the client's browser:
```php
-/* Here there will be some code where you create $objPHPExcel */
+/* Here there will be some code where you create $spreadsheet */
// redirect output to client browser
header('Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet');
header('Content-Disposition: attachment;filename="myfile.xlsx"');
header('Cache-Control: max-age=0');
-$objWriter = PHPExcel_IOFactory::createWriter($objPHPExcel, 'Xlsx');
+$objWriter = \PhpOffice\PhpSpreadsheet\IOFactory::createWriter($spreadsheet, 'Xlsx');
$objWriter->save('php://output');
```
Example of a script redirecting an Xls file to the client's browser:
```php
-/* Here there will be some code where you create $objPHPExcel */
+/* Here there will be some code where you create $spreadsheet */
// redirect output to client browser
header('Content-Type: application/vnd.ms-excel');
header('Content-Disposition: attachment;filename="myfile.xls"');
header('Cache-Control: max-age=0');
-$objWriter = PHPExcel_IOFactory::createWriter($objPHPExcel, 'Xls');
+$objWriter = \PhpOffice\PhpSpreadsheet\IOFactory::createWriter($spreadsheet, 'Xls');
$objWriter->save('php://output');
```
**Caution:**
-Make sure not to include any echo statements or output any other contents than the Excel file. There should be no whitespace before the opening tag (which can also be omitted to avoid problems). Make sure that your script is saved without a BOM (Byte-order mark) because this counts as echoing output. The same things apply to all included files.
+Make sure not to include any echo statements or output any other contents than the Excel file. There should be no whitespace before the opening tag (which can also be omitted to avoid problems). Make sure that your script is saved without a BOM (Byte-order mark) because this counts as echoing output. The same things apply to all included files.
Failing to follow the above guidelines may result in corrupt Excel files arriving at the client browser, and/or that headers cannot be set by PHP (resulting in warning messages).
### Setting the default column width
@@ -1106,7 +1102,7 @@ Failing to follow the above guidelines may result in corrupt Excel files arrivin
Default column width can be set using the following code:
```php
-$objPHPExcel->getActiveSheet()->getDefaultColumnDimension()->setWidth(12);
+$spreadsheet->getActiveSheet()->getDefaultColumnDimension()->setWidth(12);
```
### Setting the default row height
@@ -1114,12 +1110,12 @@ $objPHPExcel->getActiveSheet()->getDefaultColumnDimension()->setWidth(12);
Default row height can be set using the following code:
```php
-$objPHPExcel->getActiveSheet()->getDefaultRowDimension()->setRowHeight(15);
+$spreadsheet->getActiveSheet()->getDefaultRowDimension()->setRowHeight(15);
```
### Add a GD drawing to a worksheet
-There might be a situation where you want to generate an in-memory image using GD and add it to a PHPExcel worksheet without first having to save this file to a temporary location.
+There might be a situation where you want to generate an in-memory image using GD and add it to a `Spreadsheet` without first having to save this file to a temporary location.
Here''s an example which generates an image in memory and adds it to the active worksheet:
@@ -1127,17 +1123,17 @@ Here''s an example which generates an image in memory and adds it to the active
// Generate an image
$gdImage = @imagecreatetruecolor(120, 20) or die('Cannot Initialize new GD image stream');
$textColor = imagecolorallocate($gdImage, 255, 255, 255);
-imagestring($gdImage, 1, 5, 5, 'Created with PHPExcel', $textColor);
+imagestring($gdImage, 1, 5, 5, 'Created with PhpSpreadsheet', $textColor);
// Add a drawing to the worksheet
-$objDrawing = new PHPExcel_Worksheet_MemoryDrawing();
+$objDrawing = new \PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing();
$objDrawing->setName('Sample image');
$objDrawing->setDescription('Sample image');
$objDrawing->setImageResource($gdImage);
-$objDrawing->setRenderingFunction(PHPExcel_Worksheet_MemoryDrawing::RENDERING_JPEG);
-$objDrawing->setMimeType(PHPExcel_Worksheet_MemoryDrawing::MIMETYPE_DEFAULT);
+$objDrawing->setRenderingFunction(\PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing::RENDERING_JPEG);
+$objDrawing->setMimeType(\PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing::MIMETYPE_DEFAULT);
$objDrawing->setHeight(36);
-$objDrawing->setWorksheet($objPHPExcel->getActiveSheet());
+$objDrawing->setWorksheet($spreadsheet->getActiveSheet());
```
### Setting worksheet zoom level
@@ -1145,7 +1141,7 @@ $objDrawing->setWorksheet($objPHPExcel->getActiveSheet());
To set a worksheet's zoom level, the following code can be used:
```php
-$objPHPExcel->getActiveSheet()->getSheetView()->setZoomScale(75);
+$spreadsheet->getActiveSheet()->getSheetView()->setZoomScale(75);
```
Note that zoom level should be in range 10 – 400.
@@ -1163,7 +1159,7 @@ $objWorksheet->getTabColor()->setRGB('FF0000');
If you need to create more worksheets in the workbook, here is how:
```php
-$objWorksheet1 = $objPHPExcel->createSheet();
+$objWorksheet1 = $spreadsheet->createSheet();
$objWorksheet1->setTitle('Another sheet');
```
@@ -1174,15 +1170,15 @@ Think of createSheet() as the "Insert sheet" button in Excel. When you hit that
Set a worksheet to be __hidden__ using this code:
```php
-$objPHPExcel->getActiveSheet()
- ->setSheetState(PHPExcel_Worksheet::SHEETSTATE_HIDDEN);
+$spreadsheet->getActiveSheet()
+ ->setSheetState(\PhpOffice\PhpSpreadsheet\Worksheet::SHEETSTATE_HIDDEN);
```
Sometimes you may even want the worksheet to be __"very hidden"__. The available sheet states are :
- - PHPExcel_Worksheet::SHEETSTATE_VISIBLE
- - PHPExcel_Worksheet::SHEETSTATE_HIDDEN
- - PHPExcel_Worksheet::SHEETSTATE_VERYHIDDEN
+ - \PhpOffice\PhpSpreadsheet\Worksheet::SHEETSTATE_VISIBLE
+ - \PhpOffice\PhpSpreadsheet\Worksheet::SHEETSTATE_HIDDEN
+ - \PhpOffice\PhpSpreadsheet\Worksheet::SHEETSTATE_VERYHIDDEN
In Excel the sheet state "very hidden" can only be set programmatically, e.g. with Visual Basic Macro. It is not possible to make such a sheet visible via the user interface.
@@ -1192,7 +1188,7 @@ Worksheets can be set individually whether column "A" should start at left or ri
```php
// right-to-left worksheet
-$objPHPExcel->getActiveSheet()
+$spreadsheet->getActiveSheet()
->setRightToLeft(true);
```
diff --git a/docs/Overview/09-Calculation-Engine.md b/docs/Overview/09-Calculation-Engine.md
index c13a18c6..a2186046 100644
--- a/docs/Overview/09-Calculation-Engine.md
+++ b/docs/Overview/09-Calculation-Engine.md
@@ -1,28 +1,28 @@
-# PHPExcel Developer Documentation
+# PhpSpreadsheet Developer Documentation
-## Using the PHPExcel calculation engine
+## Using the PhpSpreadsheet calculation engine
### Performing formula calculations
-As PHPExcel represents an in-memory spreadsheet, it also offers formula calculation capabilities. A cell can be of a value type (containing a number or text), or a formula type (containing a formula which can be evaluated). For example, the formula "=SUM(A1:A10)" evaluates to the sum of values in A1, A2, ..., A10.
+As PhpSpreadsheet represents an in-memory spreadsheet, it also offers formula calculation capabilities. A cell can be of a value type (containing a number or text), or a formula type (containing a formula which can be evaluated). For example, the formula "=SUM(A1:A10)" evaluates to the sum of values in A1, A2, ..., A10.
To calculate a formula, you can call the cell containing the formula’s method getCalculatedValue(), for example:
```php
-$objPHPExcel->getActiveSheet()->getCell('E11')->getCalculatedValue();
+$spreadsheet->getActiveSheet()->getCell('E11')->getCalculatedValue();
```
-If you write the following line of code in the invoice demo included with PHPExcel, it evaluates to the value "64":
+If you write the following line of code in the invoice demo included with PhpSpreadsheet, it evaluates to the value "64":
-Another nice feature of PHPExcel's formula parser, is that it can automatically adjust a formula when inserting/removing rows/columns. Here's an example:
+Another nice feature of PhpSpreadsheet's formula parser, is that it can automatically adjust a formula when inserting/removing rows/columns. Here's an example:
You see that the formula contained in cell E11 is "SUM(E4:E9)". Now, when I write the following line of code, two new product lines are added:
```php
-$objPHPExcel->getActiveSheet()->insertNewRowBefore(7, 2);
+$spreadsheet->getActiveSheet()->insertNewRowBefore(7, 2);
```
@@ -31,11 +31,11 @@ Did you notice? The formula in the former cell E11 (now E13, as I inserted 2 new
### Known limitations
-There are some known limitations to the PHPExcel calculation engine. Most of them are due to the fact that an Excel formula is converted into PHP code before being executed. This means that Excel formula calculation is subject to PHP's language characteristics.
+There are some known limitations to the PhpSpreadsheet calculation engine. Most of them are due to the fact that an Excel formula is converted into PHP code before being executed. This means that Excel formula calculation is subject to PHP's language characteristics.
#### Operator precedence
-In Excel '+' wins over '&', just like '*' wins over '+' in ordinary algebra. The former rule is not what one finds using the calculation engine shipped with PHPExcel.
+In Excel '+' wins over '&', just like '*' wins over '+' in ordinary algebra. The former rule is not what one finds using the calculation engine shipped with PhpSpreadsheet.
Reference for operator precedence in Excel: [http://support.microsoft.com/kb/25189][18]
diff --git a/docs/Overview/10-Reading-and-Writing.md b/docs/Overview/10-Reading-and-Writing.md
index 5b62e9c3..e20ab08b 100644
--- a/docs/Overview/10-Reading-and-Writing.md
+++ b/docs/Overview/10-Reading-and-Writing.md
@@ -1,25 +1,25 @@
-# PHPExcel Developer Documentation
+# PhpSpreadsheet Developer Documentation
## Reading and writing to file
-As you already know from part REF _Ref191885438 \w \h 3.3 REF _Ref191885438 \h Readers and writers, reading and writing to a persisted storage is not possible using the base PHPExcel classes. For this purpose, PHPExcel provides readers and writers, which are implementations of PHPExcel_Writer_IReader and PHPExcel_Writer_IWriter.
+As you already know from part REF _Ref191885438 \w \h 3.3 REF _Ref191885438 \h Readers and writers, reading and writing to a persisted storage is not possible using the base PhpSpreadsheet classes. For this purpose, PhpSpreadsheet provides readers and writers, which are implementations of PHPExcel_Writer_IReader and \PhpOffice\PhpSpreadsheet\Writer\IWriter.
-### PHPExcel_IOFactory
+### \PhpOffice\PhpSpreadsheet\IOFactory
-The PHPExcel API offers multiple methods to create a PHPExcel_Writer_IReader or PHPExcel_Writer_IWriter instance:
+The PhpSpreadsheet API offers multiple methods to create a PHPExcel_Writer_IReader or \PhpOffice\PhpSpreadsheet\Writer\IWriter instance:
-Direct creation via PHPExcel_IOFactory. All examples underneath demonstrate the direct creation method. Note that you can also use the PHPExcel_IOFactory class to do this.
+Direct creation via \PhpOffice\PhpSpreadsheet\IOFactory. All examples underneath demonstrate the direct creation method. Note that you can also use the \PhpOffice\PhpSpreadsheet\IOFactory class to do this.
-#### Creating PHPExcel_Reader_IReader using PHPExcel_IOFactory
+#### Creating \PhpOffice\PhpSpreadsheet\Reader\IReader using \PhpOffice\PhpSpreadsheet\IOFactory
-There are 2 methods for reading in a file into PHPExcel: using automatic file type resolving or explicitly.
+There are 2 methods for reading in a file into PhpSpreadsheet: using automatic file type resolving or explicitly.
-Automatic file type resolving checks the different PHPExcel_Reader_IReader distributed with PHPExcel. If one of them can load the specified file name, the file is loaded using that PHPExcel_Reader_IReader. Explicit mode requires you to specify which PHPExcel_Reader_IReader should be used.
+Automatic file type resolving checks the different \PhpOffice\PhpSpreadsheet\Reader\IReader distributed with PhpSpreadsheet. If one of them can load the specified file name, the file is loaded using that \PhpOffice\PhpSpreadsheet\Reader\IReader. Explicit mode requires you to specify which \PhpOffice\PhpSpreadsheet\Reader\IReader should be used.
-You can create a PHPExcel_Reader_IReader instance using PHPExcel_IOFactory in automatic file type resolving mode using the following code sample:
+You can create a \PhpOffice\PhpSpreadsheet\Reader\IReader instance using \PhpOffice\PhpSpreadsheet\IOFactory in automatic file type resolving mode using the following code sample:
```php
-$objPHPExcel = PHPExcel_IOFactory::load("05featuredemo.xlsx");
+$spreadsheet = \PhpOffice\PhpSpreadsheet\IOFactory::load("05featuredemo.xlsx");
```
A typical use of this feature is when you need to read files uploaded by your users, and you don’t know whether they are uploading xls or xlsx files.
@@ -27,42 +27,42 @@ A typical use of this feature is when you need to read files uploaded by your us
If you need to set some properties on the reader, (e.g. to only read data, see more about this later), then you may instead want to use this variant:
```php
-$objReader = PHPExcel_IOFactory::createReaderForFile("05featuredemo.xlsx");
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReaderForFile("05featuredemo.xlsx");
$objReader->setReadDataOnly(true);
$objReader->load("05featuredemo.xlsx");
```
-You can create a PHPExcel_Reader_IReader instance using PHPExcel_IOFactory in explicit mode using the following code sample:
+You can create a \PhpOffice\PhpSpreadsheet\Reader\IReader instance using \PhpOffice\PhpSpreadsheet\IOFactory in explicit mode using the following code sample:
```php
-$objReader = PHPExcel_IOFactory::createReader("Xlsx");
-$objPHPExcel = $objReader->load("05featuredemo.xlsx");
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader("Xlsx");
+$spreadsheet = $objReader->load("05featuredemo.xlsx");
```
Note that automatic type resolving mode is slightly slower than explicit mode.
-#### Creating PHPExcel_Writer_IWriter using PHPExcel_IOFactory
+#### Creating \PhpOffice\PhpSpreadsheet\Writer\IWriter using \PhpOffice\PhpSpreadsheet\IOFactory
-You can create a PHPExcel_Writer_Iwriter instance using PHPExcel_IOFactory:
+You can create a PHPExcel_Writer_Iwriter instance using \PhpOffice\PhpSpreadsheet\IOFactory:
```php
-$objWriter = PHPExcel_IOFactory::createWriter($objPHPExcel, "Xlsx");
+$objWriter = \PhpOffice\PhpSpreadsheet\IOFactory::createWriter($spreadsheet, "Xlsx");
$objWriter->save("05featuredemo.xlsx");
```
### Excel 2007 (SpreadsheetML) file format
-Xlsx file format is the main file format of PHPExcel. It allows outputting the in-memory spreadsheet to a .xlsx file.
+Xlsx file format is the main file format of PhpSpreadsheet. It allows outputting the in-memory spreadsheet to a .xlsx file.
-#### PHPExcel_Reader_Excel2007
+#### \PhpOffice\PhpSpreadsheet\Reader\Xlsx
##### Reading a spreadsheet
You can read an .xlsx file using the following code:
```php
-$objReader = new PHPExcel_Reader_Excel2007();
-$objPHPExcel = $objReader->load("05featuredemo.xlsx");
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\Xlsx();
+$spreadsheet = $objReader->load("05featuredemo.xlsx");
```
##### Read data only
@@ -70,9 +70,9 @@ $objPHPExcel = $objReader->load("05featuredemo.xlsx");
You can set the option setReadDataOnly on the reader, to instruct the reader to ignore styling, data validation, … and just read cell data:
```php
-$objReader = new PHPExcel_Reader_Excel2007();
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\Xlsx();
$objReader->setReadDataOnly(true);
-$objPHPExcel = $objReader->load("05featuredemo.xlsx");
+$spreadsheet = $objReader->load("05featuredemo.xlsx");
```
##### Read specific sheets only
@@ -80,19 +80,19 @@ $objPHPExcel = $objReader->load("05featuredemo.xlsx");
You can set the option setLoadSheetsOnly on the reader, to instruct the reader to only load the sheets with a given name:
```php
-$objReader = new PHPExcel_Reader_Excel2007();
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\Xlsx();
$objReader->setLoadSheetsOnly( array("Sheet 1", "My special sheet") );
-$objPHPExcel = $objReader->load("05featuredemo.xlsx");
+$spreadsheet = $objReader->load("05featuredemo.xlsx");
```
##### Read specific cells only
-You can set the option setReadFilter on the reader, to instruct the reader to only load the cells which match a given rule. A read filter can be any class which implements PHPExcel_Reader_IReadFilter. By default, all cells are read using the PHPExcel_Reader_DefaultReadFilter.
+You can set the option setReadFilter on the reader, to instruct the reader to only load the cells which match a given rule. A read filter can be any class which implements \PhpOffice\PhpSpreadsheet\Reader\IReadFilter. By default, all cells are read using the \PhpOffice\PhpSpreadsheet\Reader\DefaultReadFilter.
The following code will only read row 1 and rows 20 – 30 of any sheet in the Excel file:
```php
-class MyReadFilter implements PHPExcel_Reader_IReadFilter {
+class MyReadFilter implements \PhpOffice\PhpSpreadsheet\Reader\IReadFilter {
public function readCell($column, $row, $worksheetName = '') {
// Read title row and rows 20 - 30
@@ -103,19 +103,19 @@ class MyReadFilter implements PHPExcel_Reader_IReadFilter {
}
}
-$objReader = new PHPExcel_Reader_Excel2007();
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\Xlsx();
$objReader->setReadFilter( new MyReadFilter() );
-$objPHPExcel = $objReader->load("06largescale.xlsx");
+$spreadsheet = $objReader->load("06largescale.xlsx");
```
-#### PHPExcel_Writer_Excel2007
+#### \PhpOffice\PhpSpreadsheet\Writer\Xlsx
##### Writing a spreadsheet
You can write an .xlsx file using the following code:
```php
-$objWriter = new PHPExcel_Writer_Excel2007($objPHPExcel);
+$objWriter = new \PhpOffice\PhpSpreadsheet\Writer\Xlsx($spreadsheet);
$objWriter->save("05featuredemo.xlsx");
```
@@ -124,7 +124,7 @@ $objWriter->save("05featuredemo.xlsx");
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
-$objWriter = new PHPExcel_Writer_Excel2007($objPHPExcel);
+$objWriter = new \PhpOffice\PhpSpreadsheet\Writer\Xlsx($spreadsheet);
$objWriter->setPreCalculateFormulas(false);
$objWriter->save("05featuredemo.xlsx");
```
@@ -134,7 +134,7 @@ $objWriter->save("05featuredemo.xlsx");
Because of a bug in the Office2003 compatibility pack, there can be some small issues when opening Xlsx spreadsheets (mostly related to formula calculation). You can enable Office2003 compatibility with the following code:
```
-$objWriter = new PHPExcel_Writer_Excel2007($objPHPExcel);
+$objWriter = new \PhpOffice\PhpSpreadsheet\Writer\Xlsx($spreadsheet);
$objWriter->setOffice2003Compatibility(true);
$objWriter->save("05featuredemo.xlsx");
```
@@ -144,22 +144,22 @@ Office2003 compatibility option should only be used when needed. This option dis
### Excel 5 (BIFF) file format
-Xls file format is the old Excel file format, implemented in PHPExcel to provide a uniform manner to create both .xlsx and .xls files. It is basically a modified version of [PEAR Spreadsheet_Excel_Writer][21], although it has been extended and has fewer limitations and more features than the old PEAR library. This can read all BIFF versions that use OLE2: BIFF5 (introduced with office 95) through BIFF8, but cannot read earlier versions.
+Xls file format is the old Excel file format, implemented in PhpSpreadsheet to provide a uniform manner to create both .xlsx and .xls files. It is basically a modified version of [PEAR Spreadsheet_Excel_Writer][21], although it has been extended and has fewer limitations and more features than the old PEAR library. This can read all BIFF versions that use OLE2: BIFF5 (introduced with office 95) through BIFF8, but cannot read earlier versions.
-Xls file format will not be developed any further, it just provides an additional file format for PHPExcel.
+Xls file format will not be developed any further, it just provides an additional file format for PhpSpreadsheet.
__Excel5 (BIFF) limitations__
Please note that BIFF file format has some limits regarding to styling cells and handling large spreadsheets via PHP.
-#### PHPExcel_Reader_Excel5
+#### \PhpOffice\PhpSpreadsheet\Reader\Xls
##### Reading a spreadsheet
You can read an .xls file using the following code:
```php
-$objReader = new PHPExcel_Reader_Excel5();
-$objPHPExcel = $objReader->load("05featuredemo.xls");
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\Xls();
+$spreadsheet = $objReader->load("05featuredemo.xls");
```
##### Read data only
@@ -167,9 +167,9 @@ $objPHPExcel = $objReader->load("05featuredemo.xls");
You can set the option setReadDataOnly on the reader, to instruct the reader to ignore styling, data validation, … and just read cell data:
```php
-$objReader = new PHPExcel_Reader_Excel5();
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\Xls();
$objReader->setReadDataOnly(true);
-$objPHPExcel = $objReader->load("05featuredemo.xls");
+$spreadsheet = $objReader->load("05featuredemo.xls");
```
##### Read specific sheets only
@@ -177,19 +177,19 @@ $objPHPExcel = $objReader->load("05featuredemo.xls");
You can set the option setLoadSheetsOnly on the reader, to instruct the reader to only load the sheets with a given name:
```php
-$objReader = new PHPExcel_Reader_Excel5();
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\Xls();
$objReader->setLoadSheetsOnly( array("Sheet 1", "My special sheet") );
-$objPHPExcel = $objReader->load("05featuredemo.xls");
+$spreadsheet = $objReader->load("05featuredemo.xls");
```
##### Read specific cells only
-You can set the option setReadFilter on the reader, to instruct the reader to only load the cells which match a given rule. A read filter can be any class which implements PHPExcel_Reader_IReadFilter. By default, all cells are read using the PHPExcel_Reader_DefaultReadFilter.
+You can set the option setReadFilter on the reader, to instruct the reader to only load the cells which match a given rule. A read filter can be any class which implements \PhpOffice\PhpSpreadsheet\Reader\IReadFilter. By default, all cells are read using the \PhpOffice\PhpSpreadsheet\Reader\DefaultReadFilter.
The following code will only read row 1 and rows 20 to 30 of any sheet in the Excel file:
```php
-class MyReadFilter implements PHPExcel_Reader_IReadFilter {
+class MyReadFilter implements \PhpOffice\PhpSpreadsheet\Reader\IReadFilter {
public function readCell($column, $row, $worksheetName = '') {
// Read title row and rows 20 - 30
@@ -200,19 +200,19 @@ class MyReadFilter implements PHPExcel_Reader_IReadFilter {
}
}
-$objReader = new PHPExcel_Reader_Excel5();
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\Xls();
$objReader->setReadFilter( new MyReadFilter() );
-$objPHPExcel = $objReader->load("06largescale.xls");
+$spreadsheet = $objReader->load("06largescale.xls");
```
-#### PHPExcel_Writer_Excel5
+#### \PhpOffice\PhpSpreadsheet\Writer\Xls
##### Writing a spreadsheet
You can write an .xls file using the following code:
```php
-$objWriter = new PHPExcel_Writer_Excel5($objPHPExcel);
+$objWriter = new \PhpOffice\PhpSpreadsheet\Writer\Xls($spreadsheet);
$objWriter->save("05featuredemo.xls");
```
@@ -223,25 +223,25 @@ Excel 2003 XML file format is a file format which can be used in older versions
__Excel 2003 XML limitations__
Please note that Excel 2003 XML format has some limits regarding to styling cells and handling large spreadsheets via PHP.
-#### PHPExcel_Reader_Excel2003XML
+#### \PhpOffice\PhpSpreadsheet\Reader\Excel2003XML
##### Reading a spreadsheet
You can read an Excel 2003 .xml file using the following code:
```php
-$objReader = new PHPExcel_Reader_Excel2003XML();
-$objPHPExcel = $objReader->load("05featuredemo.xml");
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\Excel2003XML();
+$spreadsheet = $objReader->load("05featuredemo.xml");
```
##### Read specific cells only
-You can set the option setReadFilter on the reader, to instruct the reader to only load the cells which match a given rule. A read filter can be any class which implements PHPExcel_Reader_IReadFilter. By default, all cells are read using the PHPExcel_Reader_DefaultReadFilter.
+You can set the option setReadFilter on the reader, to instruct the reader to only load the cells which match a given rule. A read filter can be any class which implements \PhpOffice\PhpSpreadsheet\Reader\IReadFilter. By default, all cells are read using the \PhpOffice\PhpSpreadsheet\Reader\DefaultReadFilter.
The following code will only read row 1 and rows 20 to 30 of any sheet in the Excel file:
```php
-class MyReadFilter implements PHPExcel_Reader_IReadFilter {
+class MyReadFilter implements \PhpOffice\PhpSpreadsheet\Reader\IReadFilter {
public function readCell($column, $row, $worksheetName = '') {
// Read title row and rows 20 - 30
@@ -253,9 +253,9 @@ class MyReadFilter implements PHPExcel_Reader_IReadFilter {
}
-$objReader = new PHPExcel_Reader_Excel2003XML();
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\Excel2003XML();
$objReader->setReadFilter( new MyReadFilter() );
-$objPHPExcel = $objReader->load("06largescale.xml");
+$spreadsheet = $objReader->load("06largescale.xml");
```
### Symbolic LinK (SYLK)
@@ -265,25 +265,25 @@ Symbolic Link (SYLK) is a Microsoft file format typically used to exchange data
__SYLK limitations__
Please note that SYLK file format has some limits regarding to styling cells and handling large spreadsheets via PHP.
-#### PHPExcel_Reader_SYLK
+#### \PhpOffice\PhpSpreadsheet\Reader\SYLK
##### Reading a spreadsheet
You can read an .slk file using the following code:
```php
-$objReader = new PHPExcel_Reader_SYLK();
-$objPHPExcel = $objReader->load("05featuredemo.slk");
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\SYLK();
+$spreadsheet = $objReader->load("05featuredemo.slk");
```
##### Read specific cells only
-You can set the option setReadFilter on the reader, to instruct the reader to only load the cells which match a given rule. A read filter can be any class which implements PHPExcel_Reader_IReadFilter. By default, all cells are read using the PHPExcel_Reader_DefaultReadFilter.
+You can set the option setReadFilter on the reader, to instruct the reader to only load the cells which match a given rule. A read filter can be any class which implements \PhpOffice\PhpSpreadsheet\Reader\IReadFilter. By default, all cells are read using the \PhpOffice\PhpSpreadsheet\Reader\DefaultReadFilter.
The following code will only read row 1 and rows 20 to 30 of any sheet in the SYLK file:
```php
-class MyReadFilter implements PHPExcel_Reader_IReadFilter {
+class MyReadFilter implements \PhpOffice\PhpSpreadsheet\Reader\IReadFilter {
public function readCell($column, $row, $worksheetName = '') {
// Read title row and rows 20 - 30
@@ -295,34 +295,34 @@ class MyReadFilter implements PHPExcel_Reader_IReadFilter {
}
-$objReader = new PHPExcel_Reader_SYLK();
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\SYLK();
$objReader->setReadFilter( new MyReadFilter() );
-$objPHPExcel = $objReader->load("06largescale.slk");
+$spreadsheet = $objReader->load("06largescale.slk");
```
### Open/Libre Office (.ods)
Open Office or Libre Office .ods files are the standard file format for Open Office or Libre Office Calc files.
-#### PHPExcel_Reader_OOCalc
+#### \PhpOffice\PhpSpreadsheet\Reader\Ods
##### Reading a spreadsheet
You can read an .ods file using the following code:
```php
-$objReader = new PHPExcel_Reader_OOCalc();
-$objPHPExcel = $objReader->load("05featuredemo.ods");
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\Ods();
+$spreadsheet = $objReader->load("05featuredemo.ods");
```
##### Read specific cells only
-You can set the option setReadFilter on the reader, to instruct the reader to only load the cells which match a given rule. A read filter can be any class which implements PHPExcel_Reader_IReadFilter. By default, all cells are read using the PHPExcel_Reader_DefaultReadFilter.
+You can set the option setReadFilter on the reader, to instruct the reader to only load the cells which match a given rule. A read filter can be any class which implements \PhpOffice\PhpSpreadsheet\Reader\IReadFilter. By default, all cells are read using the \PhpOffice\PhpSpreadsheet\Reader\DefaultReadFilter.
The following code will only read row 1 and rows 20 to 30 of any sheet in the Calc file:
```php
-class MyReadFilter implements PHPExcel_Reader_IReadFilter {
+class MyReadFilter implements \PhpOffice\PhpSpreadsheet\Reader\IReadFilter {
public function readCell($column, $row, $worksheetName = '') {
// Read title row and rows 20 - 30
@@ -336,42 +336,42 @@ class MyReadFilter implements PHPExcel_Reader_IReadFilter {
$objReader = new PHPExcel_Reader_OOcalc();
$objReader->setReadFilter( new MyReadFilter() );
-$objPHPExcel = $objReader->load("06largescale.ods");
+$spreadsheet = $objReader->load("06largescale.ods");
```
### CSV (Comma Separated Values)
-CSV (Comma Separated Values) are often used as an import/export file format with other systems. PHPExcel allows reading and writing to CSV files.
+CSV (Comma Separated Values) are often used as an import/export file format with other systems. PhpSpreadsheet allows reading and writing to CSV files.
__CSV limitations__
Please note that CSV file format has some limits regarding to styling cells, number formatting, ...
-#### PHPExcel_Reader_CSV
+#### \PhpOffice\PhpSpreadsheet\Reader\CSV
##### Reading a CSV file
You can read a .csv file using the following code:
```php
-$objReader = new PHPExcel_Reader_CSV();
-$objPHPExcel = $objReader->load("sample.csv");
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\CSV();
+$spreadsheet = $objReader->load("sample.csv");
```
##### Setting CSV options
-Often, CSV files are not really “comma separated”, or use semicolon (;) as a separator. You can instruct PHPExcel_Reader_CSV some options before reading a CSV file.
+Often, CSV files are not really “comma separated”, or use semicolon (;) as a separator. You can instruct \PhpOffice\PhpSpreadsheet\Reader\CSV some options before reading a CSV file.
-Note that PHPExcel_Reader_CSV by default assumes that the loaded CSV file is UTF-8 encoded. If you are reading CSV files that were created in Microsoft Office Excel the correct input encoding may rather be Windows-1252 (CP1252). Always make sure that the input encoding is set appropriately.
+Note that \PhpOffice\PhpSpreadsheet\Reader\CSV by default assumes that the loaded CSV file is UTF-8 encoded. If you are reading CSV files that were created in Microsoft Office Excel the correct input encoding may rather be Windows-1252 (CP1252). Always make sure that the input encoding is set appropriately.
```php
-$objReader = new PHPExcel_Reader_CSV();
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\CSV();
$objReader->setInputEncoding('CP1252');
$objReader->setDelimiter(';');
$objReader->setEnclosure('');
$objReader->setLineEnding("\r\n");
$objReader->setSheetIndex(0);
-$objPHPExcel = $objReader->load("sample.csv");
+$spreadsheet = $objReader->load("sample.csv");
```
##### Read a specific worksheet
@@ -384,35 +384,35 @@ $objReader->setSheetIndex(0);
##### Read into existing spreadsheet
-When working with CSV files, it might occur that you want to import CSV data into an existing PHPExcel object. The following code loads a CSV file into an existing $objPHPExcel containing some sheets, and imports onto the 6th sheet:
+When working with CSV files, it might occur that you want to import CSV data into an existing `Spreadsheet` object. The following code loads a CSV file into an existing $spreadsheet containing some sheets, and imports onto the 6th sheet:
```php
-$objReader = new PHPExcel_Reader_CSV();
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\CSV();
$objReader->setDelimiter(';');
$objReader->setEnclosure('');
$objReader->setLineEnding("\r\n");
-$objReader->setSheetIndex(5);
+$objReader->setSheetIndex(5);
-$objReader->loadIntoExisting("05featuredemo.csv", $objPHPExcel);
+$objReader->loadIntoExisting("05featuredemo.csv", $spreadsheet);
```
-#### PHPExcel_Writer_CSV
+#### \PhpOffice\PhpSpreadsheet\Writer\CSV
##### Writing a CSV file
You can write a .csv file using the following code:
```php
-$objWriter = new PHPExcel_Writer_CSV($objPHPExcel);
+$objWriter = new \PhpOffice\PhpSpreadsheet\Writer\CSV($spreadsheet);
$objWriter->save("05featuredemo.csv");
```
##### Setting CSV options
-Often, CSV files are not really “comma separated”, or use semicolon (;) as a separator. You can instruct PHPExcel_Writer_CSV some options before writing a CSV file:
+Often, CSV files are not really “comma separated”, or use semicolon (;) as a separator. You can instruct \PhpOffice\PhpSpreadsheet\Writer\CSV some options before writing a CSV file:
```php
-$objWriter = new PHPExcel_Writer_CSV($objPHPExcel);
+$objWriter = new \PhpOffice\PhpSpreadsheet\Writer\CSV($spreadsheet);
$objWriter->setDelimiter(';');
$objWriter->setEnclosure('');
$objWriter->setLineEnding("\r\n");
@@ -434,7 +434,7 @@ $objWriter->setSheetIndex(0);
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
-$objWriter = new PHPExcel_Writer_CSV($objPHPExcel);
+$objWriter = new \PhpOffice\PhpSpreadsheet\Writer\CSV($spreadsheet);
$objWriter->setPreCalculateFormulas(false);
$objWriter->save("05featuredemo.csv");
```
@@ -444,7 +444,7 @@ $objWriter->save("05featuredemo.csv");
A CSV file can be marked as UTF-8 by writing a BOM file header. This can be enabled by using the following code:
```php
-$objWriter = new PHPExcel_Writer_CSV($objPHPExcel);
+$objWriter = new \PhpOffice\PhpSpreadsheet\Writer\CSV($spreadsheet);
$objWriter->setUseBOM(true);
$objWriter->save("05featuredemo.csv");
```
@@ -453,56 +453,56 @@ $objWriter->save("05featuredemo.csv");
If the worksheet you are exporting contains numbers with decimal or thousands separators then you should think about what characters you want to use for those before doing the export.
-By default PHPExcel looks up in the server's locale settings to decide what characters to use. But to avoid problems it is recommended to set the characters explicitly as shown below.
+By default PhpSpreadsheet looks up in the server's locale settings to decide what characters to use. But to avoid problems it is recommended to set the characters explicitly as shown below.
English users will want to use this before doing the export:
```php
-PHPExcel_Shared_String::setDecimalSeparator('.');
-PHPExcel_Shared_String::setThousandsSeparator(',');
+\PhpOffice\PhpSpreadsheet\Shared\StringHelper::setDecimalSeparator('.');
+\PhpOffice\PhpSpreadsheet\Shared\StringHelper::setThousandsSeparator(',');
```
German users will want to use the opposite values.
```php
-PHPExcel_Shared_String::setDecimalSeparator(',');
-PHPExcel_Shared_String::setThousandsSeparator('.');
+\PhpOffice\PhpSpreadsheet\Shared\StringHelper::setDecimalSeparator(',');
+\PhpOffice\PhpSpreadsheet\Shared\StringHelper::setThousandsSeparator('.');
```
Note that the above code sets decimal and thousand separators as global options. This also affects how HTML and PDF is exported.
### HTML
-PHPExcel allows you to read or write a spreadsheet as HTML format, for quick representation of the data in it to anyone who does not have a spreadsheet application on their PC, or loading files saved by other scripts that simply create HTML markup and give it a .xls file extension.
+PhpSpreadsheet allows you to read or write a spreadsheet as HTML format, for quick representation of the data in it to anyone who does not have a spreadsheet application on their PC, or loading files saved by other scripts that simply create HTML markup and give it a .xls file extension.
__HTML limitations__
Please note that HTML file format has some limits regarding to styling cells, number formatting, ...
-#### PHPExcel_Reader_HTML
+#### \PhpOffice\PhpSpreadsheet\Reader\HTML
##### Reading a spreadsheet
You can read an .html or .htm file using the following code:
```php
-$objReader = new PHPExcel_Reader_HTML();
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\HTML();
-$objPHPExcel = $objReader->load("05featuredemo.html");
+$spreadsheet = $objReader->load("05featuredemo.html");
```
__HTML limitations__
Please note that HTML reader is still experimental and does not yet support merged cells or nested tables cleanly
-#### PHPExcel_Writer_HTML
+#### \PhpOffice\PhpSpreadsheet\Writer\HTML
-Please note that PHPExcel_Writer_HTML only outputs the first worksheet by default.
+Please note that \PhpOffice\PhpSpreadsheet\Writer\HTML only outputs the first worksheet by default.
##### Writing a spreadsheet
You can write a .htm file using the following code:
```php
-$objWriter = new PHPExcel_Writer_HTML($objPHPExcel);
+$objWriter = new \PhpOffice\PhpSpreadsheet\Writer\HTML($spreadsheet);
$objWriter->save("05featuredemo.htm");
```
@@ -525,9 +525,9 @@ $objWriter->setSheetIndex(0);
##### Setting the images root of the HTML file
-There might be situations where you want to explicitly set the included images root. For example, one might want to see
+There might be situations where you want to explicitly set the included images root. For example, one might want to see
```html
-
+
```
instead of
@@ -547,7 +547,7 @@ $objWriter->setImagesRoot('http://www.example.com');
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
-$objWriter = new PHPExcel_Writer_HTML($objPHPExcel);
+$objWriter = new \PhpOffice\PhpSpreadsheet\Writer\HTML($spreadsheet);
$objWriter->setPreCalculateFormulas(false);
$objWriter->save("05featuredemo.htm");
@@ -555,7 +555,7 @@ $objWriter->save("05featuredemo.htm");
##### Embedding generated HTML in a web page
-There might be a situation where you want to embed the generated HTML in an existing website. PHPExcel_Writer_HTML provides support to generate only specific parts of the HTML code, which allows you to use these parts in your website.
+There might be a situation where you want to embed the generated HTML in an existing website. \PhpOffice\PhpSpreadsheet\Writer\HTML provides support to generate only specific parts of the HTML code, which allows you to use these parts in your website.
Supported methods:
@@ -568,7 +568,7 @@ Here's an example which retrieves all parts independently and merges them into a
```php
generateHTMLHeader();
?>
@@ -598,7 +598,7 @@ echo $objWriter->generateHTMLFooter();
A HTML file can be marked as UTF-8 by writing a BOM file header. This can be enabled by using the following code:
```php
-$objWriter = new PHPExcel_Writer_HTML($objPHPExcel);
+$objWriter = new \PhpOffice\PhpSpreadsheet\Writer\HTML($spreadsheet);
$objWriter->setUseBOM(true);
$objWriter->save("05featuredemo.htm");
@@ -606,22 +606,22 @@ $objWriter->save("05featuredemo.htm");
##### Decimal and thousands separators
-See section PHPExcel_Writer_CSV how to control the appearance of these.
+See section \PhpOffice\PhpSpreadsheet\Writer\CSV how to control the appearance of these.
### PDF
-PHPExcel allows you to write a spreadsheet into PDF format, for fast distribution of represented data.
+PhpSpreadsheet allows you to write a spreadsheet into PDF format, for fast distribution of represented data.
__PDF limitations__
Please note that PDF file format has some limits regarding to styling cells, number formatting, ...
-#### PHPExcel_Writer_PDF
+#### \PhpOffice\PhpSpreadsheet\Writer\PDF
-PHPExcel’s PDF Writer is a wrapper for a 3rd-Party PDF Rendering library such as tcPDF, mPDF or DomPDF. Prior to version 1.7.8 of PHPExcel, the tcPDF library was bundled with PHPExcel; but from version 1.7.8 this was removed. Instead, you must now install a PDF Rendering library yourself; but PHPExcel will work with a number of different libraries.
+PhpSpreadsheet’s PDF Writer is a wrapper for a 3rd-Party PDF Rendering library such as tcPDF, mPDF or DomPDF. You must now install a PDF Rendering library yourself; but PhpSpreadsheet will work with a number of different libraries.
Currently, the following libraries are supported:
-Library | Version used for testing | Downloadable from | PHPExcel Internal Constant
+Library | Version used for testing | Downloadable from | PhpSpreadsheet Internal Constant
--------|--------------------------|----------------------------------|----------------------------
tcPDF | 5.9 | http://www.tcpdf.org/ | PDF_RENDERER_TCPDF
mPDF | 5.4 | http://www.mpdf1.com/mpdf/ | PDF_RENDERER_MPDF
@@ -632,11 +632,11 @@ The different libraries have different strengths and weaknesses. Some generate b
Before instantiating a Writer to generate PDF output, you will need to indicate which Rendering library you are using, and where it is located.
```php
-$rendererName = PHPExcel_Settings::PDF_RENDERER_MPDF;
+$rendererName = \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_MPDF;
$rendererLibrary = 'mPDF5.4';
$rendererLibraryPath = dirname(__FILE__).'/../../../libraries/PDF/' . $rendererLibrary;
-if (!PHPExcel_Settings::setPdfRenderer(
+if (!\PhpOffice\PhpSpreadsheet\Settings::setPdfRenderer(
$rendererName,
$rendererLibraryPath
)) {
@@ -653,11 +653,11 @@ if (!PHPExcel_Settings::setPdfRenderer(
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
-$objWriter = new PHPExcel_Writer_PDF($objPHPExcel);
+$objWriter = new \PhpOffice\PhpSpreadsheet\Writer\PDF($spreadsheet);
$objWriter->save("05featuredemo.pdf");
```
-Please note that PHPExcel_Writer_PDF only outputs the first worksheet by default.
+Please note that \PhpOffice\PhpSpreadsheet\Writer\PDF only outputs the first worksheet by default.
##### Write all worksheets
@@ -680,7 +680,7 @@ $objWriter->setSheetIndex(0);
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
-$objWriter = new PHPExcel_Writer_PDF($objPHPExcel);
+$objWriter = new \PhpOffice\PhpSpreadsheet\Writer\PDF($spreadsheet);
$objWriter->setPreCalculateFormulas(false);
$objWriter->save("05featuredemo.pdf");
@@ -688,7 +688,7 @@ $objWriter->save("05featuredemo.pdf");
##### Decimal and thousands separators
-See section PHPExcel_Writer_CSV how to control the appearance of these.
+See section \PhpOffice\PhpSpreadsheet\Writer\CSV how to control the appearance of these.
### Generating Excel files from templates (read, modify, write)
@@ -697,14 +697,14 @@ Readers and writers are the tools that allow you to generate Excel files from te
Here is an example how to open a template file, fill in a couple of fields and save it again:
```php
-$objPHPexcel = PHPExcel_IOFactory::load('template.xlsx');
+$spreadsheet = \PhpOffice\PhpSpreadsheet\IOFactory::load('template.xlsx');
-$objWorksheet = $objPHPexcel->getActiveSheet();
+$objWorksheet = $spreadsheet->getActiveSheet();
$objWorksheet->getCell('A1')->setValue('John');
$objWorksheet->getCell('A2')->setValue('Smith');
-$objWriter = PHPExcel_IOFactory::createWriter($objPHPexcel, 'Xls');
+$objWriter = \PhpOffice\PhpSpreadsheet\IOFactory::createWriter($spreadsheet, 'Xls');
$objWriter->save('write.xls');
```
diff --git a/docs/Overview/11-Appendices.md b/docs/Overview/11-Appendices.md
index 6c02653e..a777ed48 100644
--- a/docs/Overview/11-Appendices.md
+++ b/docs/Overview/11-Appendices.md
@@ -1,4 +1,4 @@
-# PHPExcel Developer Documentation
+# PhpSpreadsheet Developer Documentation
## Credits
@@ -6,9 +6,9 @@ Please refer to the internet page [http://www.codeplex.com/PHPExcel/Wiki/View.as
## Valid array keys for style applyFromArray()
-The following table lists the valid array keys for PHPExcel_Style applyFromArray() classes. If the "Maps to property" column maps a key to a setter, the value provided for that key will be applied directly. If the "Maps to property" column maps a key to a getter, the value provided for that key will be applied as another style array.
+The following table lists the valid array keys for \PhpOffice\PhpSpreadsheet\Style applyFromArray() classes. If the "Maps to property" column maps a key to a setter, the value provided for that key will be applied directly. If the "Maps to property" column maps a key to a getter, the value provided for that key will be applied as another style array.
-__PHPExcel_Style__
+__\PhpOffice\PhpSpreadsheet\Style__
Array key | Maps to property
-------------|-------------------
@@ -20,7 +20,7 @@ __PHPExcel_Style__
protection | getProtection()
-__PHPExcel_Style_Fill__
+__\PhpOffice\PhpSpreadsheet\Style\Fill__
Array key | Maps to property
-----------|-------------------
@@ -31,7 +31,7 @@ __PHPExcel_Style_Fill__
color | getStartColor()
-__PHPExcel_Style_Font__
+__\PhpOffice\PhpSpreadsheet\Style\Font__
Array key | Maps to property
------------|-------------------
@@ -46,7 +46,7 @@ __PHPExcel_Style_Font__
subScript | setSubScript()
-__PHPExcel_Style_Borders__
+__\PhpOffice\PhpSpreadsheet\Style\Borders__
Array key | Maps to property
------------------|-------------------
@@ -62,7 +62,7 @@ __PHPExcel_Style_Borders__
outline | setOutline()
-__PHPExcel_Style_Border__
+__\PhpOffice\PhpSpreadsheet\Style\Border__
Array key | Maps to property
----------|-------------------
@@ -70,7 +70,7 @@ __PHPExcel_Style_Border__
color | getColor()
-__PHPExcel_Style_Alignment__
+__\PhpOffice\PhpSpreadsheet\Style\Alignment__
Array key | Maps to property
------------|-------------------
@@ -82,14 +82,14 @@ __PHPExcel_Style_Alignment__
indent | setIndent()
-__PHPExcel_Style_NumberFormat__
+__\PhpOffice\PhpSpreadsheet\Style\NumberFormat__
Array key | Maps to property
----------|-------------------
code | setFormatCode()
-__PHPExcel_Style_Protection__
+__\PhpOffice\PhpSpreadsheet\Style\Protection__
Array key | Maps to property
----------|-------------------
diff --git a/docs/ReadingSpreadsheetFiles/01-File-Formats.md b/docs/ReadingSpreadsheetFiles/01-File-Formats.md
index b81505a2..38c021b9 100644
--- a/docs/ReadingSpreadsheetFiles/01-File-Formats.md
+++ b/docs/ReadingSpreadsheetFiles/01-File-Formats.md
@@ -1,11 +1,11 @@
-# PHPExcel User Documentation – Reading Spreadsheet Files
+# PhpSpreadsheet User Documentation – Reading Spreadsheet Files
## Spreadsheet File Formats
-PHPExcel can read a number of different spreadsheet and file formats, although not all features are supported by all of the readers. Check the Functionality Cross-Reference document (Functionality Cross-Reference.xls) for a list that identifies which features are supported by which readers.
+PhpSpreadsheet can read a number of different spreadsheet and file formats, although not all features are supported by all of the readers. Check the Functionality Cross-Reference document (Functionality Cross-Reference.xls) for a list that identifies which features are supported by which readers.
-Currently, PHPExcel supports the following File Types for Reading:
+Currently, PhpSpreadsheet supports the following File Types for Reading:
### Xls
diff --git a/docs/ReadingSpreadsheetFiles/02-Security.md b/docs/ReadingSpreadsheetFiles/02-Security.md
index 12da958f..5c31947b 100644
--- a/docs/ReadingSpreadsheetFiles/02-Security.md
+++ b/docs/ReadingSpreadsheetFiles/02-Security.md
@@ -1,4 +1,4 @@
-# PHPExcel User Documentation – Reading Spreadsheet Files
+# PhpSpreadsheet User Documentation – Reading Spreadsheet Files
## Security
@@ -8,6 +8,6 @@ XML-based formats such as OfficeOpen XML, Excel2003 XML, OASIS and Gnumeric are
- Disclosure whether a file is existent
- Server Side Request Forgery
- Command Execution (depending on the installed PHP wrappers)
-
-To prevent this, PHPExcel sets `libxml_disable_entity_loader` to `true` for the XML-based Readers by default.
\ No newline at end of file
+
+To prevent this, PhpSpreadsheet sets `libxml_disable_entity_loader` to `true` for the XML-based Readers by default.
\ No newline at end of file
diff --git a/docs/ReadingSpreadsheetFiles/03-Loading-a-Spreadsheet.md b/docs/ReadingSpreadsheetFiles/03-Loading-a-Spreadsheet.md
index e5e6ffe9..c3f70110 100644
--- a/docs/ReadingSpreadsheetFiles/03-Loading-a-Spreadsheet.md
+++ b/docs/ReadingSpreadsheetFiles/03-Loading-a-Spreadsheet.md
@@ -1,21 +1,21 @@
-# PHPExcel User Documentation – Reading Spreadsheet Files
+# PhpSpreadsheet User Documentation – Reading Spreadsheet Files
## Loading a Spreadsheet File
-The simplest way to load a workbook file is to let PHPExcel's IO Factory identify the file type and load it, calling the static load() method of the PHPExcel_IOFactory class.
+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
$inputFileName = './sampleData/example1.xls';
-/** Load $inputFileName to a PHPExcel Object **/
-$objPHPExcel = PHPExcel_IOFactory::load($inputFileName);
+/** Load $inputFileName to a Spreadsheet Object **/
+$spreadsheet = \PhpOffice\PhpSpreadsheet\IOFactory::load($inputFileName);
```
> See Examples/Reader/exampleReader01.php for a working example of this code.
-The load() method will attempt to identify the file type, and instantiate a loader for that file type; using it to load the file and store the data and any formatting in a PHPExcel object.
+The load() method will attempt to identify the file type, and instantiate a loader for that file type; using it to load the file and store the data and any formatting in a `Spreadsheet` object.
The method makes an initial guess at the loader to instantiate based on the file extension; but will test the file before actually executing the load: so if (for example) the file is actually a CSV file or contains HTML markup, but that has been given a .xls extension (quite a common practise), it will reject the Xls loader that it would normally use for a .xls file; and test the file using the other loaders until it finds the appropriate loader, and then use that to read the file.
-While easy to implement in your code, and you don't need to worry about the file type; this isn't the most efficient method to load a file; and it lacks the flexibility to configure the loader in any way before actually reading the file into a PHPExcel object.
+While easy to implement in your code, and you don't need to worry about the file type; this isn't the most efficient method to load a file; and it lacks the flexibility to configure the loader in any way before actually reading the file into a `Spreadsheet` object.
diff --git a/docs/ReadingSpreadsheetFiles/04-Loading-with-a-Reader.md b/docs/ReadingSpreadsheetFiles/04-Loading-with-a-Reader.md
index 83be909c..06a5f6eb 100644
--- a/docs/ReadingSpreadsheetFiles/04-Loading-with-a-Reader.md
+++ b/docs/ReadingSpreadsheetFiles/04-Loading-with-a-Reader.md
@@ -1,23 +1,23 @@
-# PHPExcel User Documentation – Reading Spreadsheet Files
+# PhpSpreadsheet User Documentation – Reading Spreadsheet Files
## Creating a Reader and Loading a Spreadsheet File
-If you know the file type of the spreadsheet file that you need to load, you can instantiate a new reader object for that file type, then use the reader's load() method to read the file to a PHPExcel object. It is possible to instantiate the reader objects for each of the different 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.
+If you know the file type of the spreadsheet file that you need to load, you can instantiate a new reader object for that file type, then use the reader's load() method to read the file to a `Spreadsheet` object. It is possible to instantiate the reader objects for each of the different 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
$inputFileName = './sampleData/example1.xls';
/** Create a new Xls Reader **/
-$objReader = new PHPExcel_Reader_Excel5();
-// $objReader = new PHPExcel_Reader_Excel2007();
-// $objReader = new PHPExcel_Reader_Excel2003XML();
-// $objReader = new PHPExcel_Reader_OOCalc();
-// $objReader = new PHPExcel_Reader_SYLK();
-// $objReader = new PHPExcel_Reader_Gnumeric();
-// $objReader = new PHPExcel_Reader_CSV();
-/** Load $inputFileName to a PHPExcel Object **/
-$objPHPExcel = $objReader->load($inputFileName);
+$objReader = new \PhpOffice\PhpSpreadsheet\Reader\Xls();
+// $objReader = new \PhpOffice\PhpSpreadsheet\Reader\Xlsx();
+// $objReader = new \PhpOffice\PhpSpreadsheet\Reader\Excel2003XML();
+// $objReader = new \PhpOffice\PhpSpreadsheet\Reader\Ods();
+// $objReader = new \PhpOffice\PhpSpreadsheet\Reader\SYLK();
+// $objReader = new \PhpOffice\PhpSpreadsheet\Reader\Gnumeric();
+// $objReader = new \PhpOffice\PhpSpreadsheet\Reader\CSV();
+/** Load $inputFileName to a Spreadsheet Object **/
+$spreadsheet = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader02.php for a working example of this code.
@@ -34,9 +34,9 @@ $inputFileType = 'Xls';
$inputFileName = './sampleData/example1.xls';
/** Create a new Reader of the type defined in $inputFileType **/
-$objReader = PHPExcel_IOFactory::createReader($inputFileType);
-/** Load $inputFileName to a PHPExcel Object **/
-$objPHPExcel = $objReader->load($inputFileName);
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
+/** Load $inputFileName to a Spreadsheet Object **/
+$spreadsheet = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader03.php for a working example of this code.
@@ -46,11 +46,11 @@ If you're uncertain of the filetype, you can use the IO Factory's identify() met
$inputFileName = './sampleData/example1.xls';
/** Identify the type of $inputFileName **/
-$inputFileType = PHPExcel_IOFactory::identify($inputFileName);
+$inputFileType = \PhpOffice\PhpSpreadsheet\IOFactory::identify($inputFileName);
/** Create a new Reader of the type that has been identified **/
-$objReader = PHPExcel_IOFactory::createReader($inputFileType);
-/** Load $inputFileName to a PHPExcel Object **/
-$objPHPExcel = $objReader->load($inputFileName);
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
+/** Load $inputFileName to a Spreadsheet Object **/
+$spreadsheet = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader04.php for a working example of this code.
diff --git a/docs/ReadingSpreadsheetFiles/05-Reader-Options.md b/docs/ReadingSpreadsheetFiles/05-Reader-Options.md
index 753f384b..a1576883 100644
--- a/docs/ReadingSpreadsheetFiles/05-Reader-Options.md
+++ b/docs/ReadingSpreadsheetFiles/05-Reader-Options.md
@@ -1,4 +1,4 @@
-# PHPExcel User Documentation – Reading Spreadsheet Files
+# PhpSpreadsheet User Documentation – Reading Spreadsheet Files
## Spreadsheet Reader Options
@@ -13,15 +13,15 @@ $inputFileType = 'Xls';
$inputFileName = './sampleData/example1.xls';
/** Create a new Reader of the type defined in $inputFileType **/
-$objReader = PHPExcel_IOFactory::createReader($inputFileType);
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
/** Advise the Reader that we only want to load cell data **/
$objReader->setReadDataOnly(true);
-/** Load $inputFileName to a PHPExcel Object **/
-$objPHPExcel = $objReader->load($inputFileName);
+/** Load $inputFileName to a Spreadsheet Object **/
+$spreadsheet = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader05.php for a working example of this code.
-It is important to note that Workbooks (and PHPExcel) store dates and times as simple numeric values: they can only be distinguished from other numeric values by the format mask that is applied to that cell. When setting read data only to true, PHPExcel doesn't read the cell format masks, so it is not possible to differentiate between dates/times and numbers.
+It is important to note that Workbooks (and PhpSpreadsheet) store dates and times as simple numeric values: they can only be distinguished from other numeric values by the format mask that is applied to that cell. When setting read data only to true, PhpSpreadsheet doesn't read the cell format masks, so it is not possible to differentiate between dates/times and numbers.
The Gnumeric loader has been written to read the format masks for date values even when read data only has been set to true, so it can differentiate between dates/times and numbers; but this change hasn't yet been implemented for the other readers.
@@ -45,11 +45,11 @@ $inputFileName = './sampleData/example1.xls';
$sheetname = 'Data Sheet #2';
/** Create a new Reader of the type defined in $inputFileType **/
-$objReader = PHPExcel_IOFactory::createReader($inputFileType);
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
/** Advise the Reader of which WorkSheets we want to load **/
$objReader->setLoadSheetsOnly($sheetname);
-/** Load $inputFileName to a PHPExcel Object **/
-$objPHPExcel = $objReader->load($inputFileName);
+/** Load $inputFileName to a Spreadsheet Object **/
+$spreadsheet = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader07.php for a working example of this code.
@@ -61,11 +61,11 @@ $inputFileName = './sampleData/example1.xls';
$sheetnames = array('Data Sheet #1','Data Sheet #3');
/** Create a new Reader of the type defined in $inputFileType **/
-$objReader = PHPExcel_IOFactory::createReader($inputFileType);
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
/** Advise the Reader of which WorkSheets we want to load **/
$objReader->setLoadSheetsOnly($sheetnames);
-/** Load $inputFileName to a PHPExcel Object **/
-$objPHPExcel = $objReader->load($inputFileName);
+/** Load $inputFileName to a Spreadsheet Object **/
+$spreadsheet = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader08.php for a working example of this code.
@@ -76,11 +76,11 @@ $inputFileType = 'Xls';
$inputFileName = './sampleData/example1.xls';
/** Create a new Reader of the type defined in $inputFileType **/
-$objReader = PHPExcel_IOFactory::createReader($inputFileType);
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
/** Advise the Reader to load all Worksheets **/
$objReader->setLoadAllSheets();
-/** Load $inputFileName to a PHPExcel Object **/
-$objPHPExcel = $objReader->load($inputFileName);
+/** Load $inputFileName to a Spreadsheet Object **/
+$spreadsheet = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader06.php for a working example of this code.
@@ -94,7 +94,7 @@ CSV | NO | HTML | NO
### Reading Only Specific Columns and Rows from a File (Read Filters)
-If you are only interested in reading part of a worksheet, then you can write a filter class that identifies whether or not individual cells should be read by the loader. A read filter must implement the PHPExcel_Reader_IReadFilter interface, and contain a readCell() method that accepts arguments of $column, $row and $worksheetName, and return a boolean true or false that indicates whether a workbook cell identified by those arguments should be read or not.
+If you are only interested in reading part of a worksheet, then you can write a filter class that identifies whether or not individual cells should be read by the loader. A read filter must implement the \PhpOffice\PhpSpreadsheet\Reader\IReadFilter interface, and contain a readCell() method that accepts arguments of $column, $row and $worksheetName, and return a boolean true or false that indicates whether a workbook cell identified by those arguments should be read or not.
```php
$inputFileType = 'Xls';
@@ -102,8 +102,8 @@ $inputFileName = './sampleData/example1.xls';
$sheetname = 'Data Sheet #3';
-/** Define a Read Filter class implementing PHPExcel_Reader_IReadFilter */
-class MyReadFilter implements PHPExcel_Reader_IReadFilter
+/** Define a Read Filter class implementing \PhpOffice\PhpSpreadsheet\Reader\IReadFilter */
+class MyReadFilter implements \PhpOffice\PhpSpreadsheet\Reader\IReadFilter
{
public function readCell($column, $row, $worksheetName = '') {
// Read rows 1 to 7 and columns A to E only
@@ -120,19 +120,19 @@ class MyReadFilter implements PHPExcel_Reader_IReadFilter
$filterSubset = new MyReadFilter();
/** Create a new Reader of the type defined in $inputFileType **/
-$objReader = PHPExcel_IOFactory::createReader($inputFileType);
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
/** Tell the Reader that we want to use the Read Filter **/
$objReader->setReadFilter($filterSubset);
-/** Load only the rows and columns that match our filter to PHPExcel **/
-$objPHPExcel = $objReader->load($inputFileName);
+/** Load only the rows and columns that match our filter to Spreadsheet **/
+$spreadsheet = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader09.php for a working example of this code.
This example is not particularly useful, because it can only be used in 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
-/** Define a Read Filter class implementing PHPExcel_Reader_IReadFilter */
-class MyReadFilter implements PHPExcel_Reader_IReadFilter
+/** Define a Read Filter class implementing \PhpOffice\PhpSpreadsheet\Reader\IReadFilter */
+class MyReadFilter implements \PhpOffice\PhpSpreadsheet\Reader\IReadFilter
{
private $_startRow = 0;
private $_endRow = 0;
@@ -168,8 +168,8 @@ $inputFileType = 'Xls';
$inputFileName = './sampleData/example2.xls';
-/** Define a Read Filter class implementing PHPExcel_Reader_IReadFilter */
-class chunkReadFilter implements PHPExcel_Reader_IReadFilter
+/** Define a Read Filter class implementing \PhpOffice\PhpSpreadsheet\Reader\IReadFilter */
+class chunkReadFilter implements \PhpOffice\PhpSpreadsheet\Reader\IReadFilter
{
private $_startRow = 0;
private $_endRow = 0;
@@ -191,7 +191,7 @@ class chunkReadFilter implements PHPExcel_Reader_IReadFilter
/** Create a new Reader of the type defined in $inputFileType **/
-$objReader = PHPExcel_IOFactory::createReader($inputFileType);
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
/** Define how many rows we want to read for each "chunk" **/
@@ -207,7 +207,7 @@ for ($startRow = 2; $startRow <= 65536; $startRow += $chunkSize) {
/** Tell the Read Filter which rows we want this iteration **/
$chunkFilter->setRows($startRow,$chunkSize);
/** Load only the rows that match our filter **/
- $objPHPExcel = $objReader->load($inputFileName);
+ $spreadsheet = $objReader->load($inputFileName);
// Do some processing here
}
```
@@ -221,9 +221,9 @@ Xlsx | YES | Xls | YES | Excel2003XML | YES |
Ods | YES | SYLK | NO | Gnumeric | YES |
CSV | YES | HTML | NO
-### Combining Multiple Files into a Single PHPExcel Object
+### Combining Multiple Files into a Single Spreadsheet Object
-While you can limit the number of worksheets that are read from a workbook file using the setLoadSheetsOnly() method, certain readers also allow you to combine several individual "sheets" from different files into a single PHPExcel object, where each individual file is a single worksheet within that workbook. For each file that you read, you need to indicate which worksheet index it should be loaded into using the setSheetIndex() method of the $objReader, then use the loadIntoExisting() method rather than the load() method to actually read the file into that worksheet.
+While you can limit the number of worksheets that are read from a workbook file using the setLoadSheetsOnly() method, certain readers also allow you to combine several individual "sheets" from different files into a single `Spreadsheet` object, where each individual file is a single worksheet within that workbook. For each file that you read, you need to indicate which worksheet index it should be loaded into using the setSheetIndex() method of the $objReader, then use the loadIntoExisting() method rather than the load() method to actually read the file into that worksheet.
```php
$inputFileType = 'CSV';
@@ -233,15 +233,15 @@ $inputFileNames = array('./sampleData/example1.csv',
);
/** Create a new Reader of the type defined in $inputFileType **/
-$objReader = PHPExcel_IOFactory::createReader($inputFileType);
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
/** Extract the first named file from the array list **/
$inputFileName = array_shift($inputFileNames);
-/** Load the initial file to the first worksheet in a PHPExcel Object **/
-$objPHPExcel = $objReader->load($inputFileName);
+/** Load the initial file to the first worksheet in a `Spreadsheet` Object **/
+$spreadsheet = $objReader->load($inputFileName);
/** Set the worksheet title (to the filename that we've loaded) **/
-$objPHPExcel->getActiveSheet()
+$spreadsheet->getActiveSheet()
->setTitle(pathinfo($inputFileName,PATHINFO_BASENAME));
@@ -249,10 +249,10 @@ $objPHPExcel->getActiveSheet()
foreach($inputFileNames as $sheet => $inputFileName) {
/** Increment the worksheet index pointer for the Reader **/
$objReader->setSheetIndex($sheet+1);
- /** Load the current file into a new worksheet in PHPExcel **/
- $objReader->loadIntoExisting($inputFileName,$objPHPExcel);
+ /** Load the current file into a new worksheet in Spreadsheet **/
+ $objReader->loadIntoExisting($inputFileName,$spreadsheet);
/** Set the worksheet title (to the filename that we've loaded) **/
- $objPHPExcel->getActiveSheet()
+ $spreadsheet->getActiveSheet()
->setTitle(pathinfo($inputFileName,PATHINFO_BASENAME));
}
```
@@ -260,7 +260,7 @@ foreach($inputFileNames as $sheet => $inputFileName) {
Note that using the same sheet index for multiple sheets won't append files into the same sheet, but overwrite the results of the previous load. You cannot load multiple CSV files into the same worksheet.
-Combining Multiple Files into a Single PHPExcel Object applies to:
+Combining Multiple Files into a Single Spreadsheet Object applies to:
Reader | Y/N |Reader | Y/N |Reader | Y/N |
----------|:---:|--------|:---:|--------------|:---:|
@@ -279,7 +279,7 @@ $inputFileName = './sampleData/example2.csv';
echo 'Loading file ',pathinfo($inputFileName,PATHINFO_BASENAME),' using IOFactory with a defined reader type of ',$inputFileType,'
';
/** Create a new Reader of the type defined in $inputFileType **/
-$objReader = PHPExcel_IOFactory::createReader($inputFileType);
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
/** Define how many rows we want to read for each "chunk" **/
@@ -293,8 +293,8 @@ $chunkFilter = new chunkReadFilter();
$objReader->setReadFilter($chunkFilter)
->setContiguous(true);
-/** Instantiate a new PHPExcel object manually **/
-$objPHPExcel = new PHPExcel();
+/** Instantiate a new Spreadsheet object manually **/
+$spreadsheet = new \PhpOffice\PhpSpreadsheet\Spreadsheet();
/** Set a sheet index **/
$sheet = 0;
@@ -307,10 +307,10 @@ for ($startRow = 2; $startRow <= 1000000; $startRow += $chunkSize) {
/** Increment the worksheet index pointer for the Reader **/
$objReader->setSheetIndex($sheet);
/** Load only the rows that match our filter into a new worksheet **/
- $objReader->loadIntoExisting($inputFileName,$objPHPExcel);
+ $objReader->loadIntoExisting($inputFileName,$spreadsheet);
/** Set the worksheet title for the sheet that we've justloaded) **/
/** and increment the sheet index as well **/
- $objPHPExcel->getActiveSheet()->setTitle('Country Data #'.(++$sheet));
+ $spreadsheet->getActiveSheet()->setTitle('Country Data #'.(++$sheet));
}
```
> See Examples/Reader/exampleReader14.php for a working example of this code.
@@ -319,7 +319,7 @@ This code will read 65,530 rows at a time from the CSV file that we’re loading
The setContiguous() method for the Reader is important here. It is applicable only when working with a Read Filter, and identifies whether or not the cells should be stored by their position within the CSV file, or their position relative to the filter.
-For example, if the filter returned true for cells in the range B2:C3, then with setContiguous set to false (the default) these would be loaded as B2:C3 in the PHPExcel object; but with setContiguous set to true, they would be loaded as A1:B2.
+For example, if the filter returned true for cells in the range B2:C3, then with setContiguous set to false (the default) these would be loaded as B2:C3 in the `Spreadsheet` object; but with setContiguous set to true, they would be loaded as A1:B2.
Splitting a single loaded file across multiple worksheets applies to:
@@ -337,13 +337,13 @@ The CSV loader defaults to loading a file where comma is used as the separator,
$inputFileType = 'CSV';
$inputFileName = './sampleData/example1.tsv';
-/** Create a new Reader of the type defined in $inputFileType **/ $objReader = PHPExcel_IOFactory::createReader($inputFileType);
+/** Create a new Reader of the type defined in $inputFileType **/ $objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
/** Set the delimiter to a TAB character **/
$objReader->setDelimiter("\t");
// $objReader->setDelimiter('|');
-/** Load the file to a PHPExcel Object **/
-$objPHPExcel = $objReader->load($inputFileName);
+/** Load the file to a Spreadsheet Object **/
+$spreadsheet = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader15.php for a working example of this code.
@@ -363,22 +363,22 @@ CSV | YES | HTML | NO
### A Brief Word about the Advanced Value Binder
-When loading data from a file that contains no formatting information, such as a CSV file, then data is read either as strings or numbers (float or integer). This means that PHPExcel does not automatically recognise dates/times (such as "16-Apr-2009" or "13:30"), booleans ("TRUE" or "FALSE"), percentages ("75%"), hyperlinks ("http://www.phpexcel.net"), etc as anything other than simple strings. However, you can apply additional processing that is executed against these values during the load process within a Value Binder.
+When loading data from a file that contains no formatting information, such as a CSV file, then data is read either as strings or numbers (float or integer). This means that PhpSpreadsheet does not automatically recognise dates/times (such as "16-Apr-2009" or "13:30"), booleans ("TRUE" or "FALSE"), percentages ("75%"), hyperlinks ("http://www.phpexcel.net"), etc as anything other than simple strings. However, you can apply additional processing that is executed against these values during the load process within a Value Binder.
-A Value Binder is a class that implement the PHPExcel_Cell_IValueBinder interface. It must contain a bindValue() method that accepts a PHPExcel_Cell and a value as arguments, and return a boolean true or false that indicates whether the workbook cell has been populated with the value or not. The Advanced Value Binder implements such a class: amongst other tests, it identifies a string comprising "TRUE" or "FALSE" (based on locale settings) and sets it to a boolean; or a number in scientific format (e.g. "1.234e-5") and converts it to a float; or dates and times, converting them to their Excel timestamp value – before storing the value in the cell object. It also sets formatting for strings that are identified as dates, times or percentages. It could easily be extended to provide additional handling (including text or cell formatting) when it encountered a hyperlink, or HTML markup within a CSV file.
+A Value Binder is a class that implement the \PhpOffice\PhpSpreadsheet\Cell\IValueBinder interface. It must contain a bindValue() method that accepts a \PhpOffice\PhpSpreadsheet\Cell and a value as arguments, and return a boolean true or false that indicates whether the workbook cell has been populated with the value or not. The Advanced Value Binder implements such a class: amongst other tests, it identifies a string comprising "TRUE" or "FALSE" (based on locale settings) and sets it to a boolean; or a number in scientific format (e.g. "1.234e-5") and converts it to a float; or dates and times, converting them to their Excel timestamp value – before storing the value in the cell object. It also sets formatting for strings that are identified as dates, times or percentages. It could easily be extended to provide additional handling (including text or cell formatting) when 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
-/** Tell PHPExcel that we want to use the Advanced Value Binder **/
-PHPExcel_Cell::setValueBinder( new PHPExcel_Cell_AdvancedValueBinder() );
+/** Tell PhpSpreadsheet that we want to use the Advanced Value Binder **/
+\PhpOffice\PhpSpreadsheet\Cell::setValueBinder( new \PhpOffice\PhpSpreadsheet\Cell\AdvancedValueBinder() );
$inputFileType = 'CSV';
$inputFileName = './sampleData/example1.tsv';
-$objReader = PHPExcel_IOFactory::createReader($inputFileType);
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
$objReader->setDelimiter("\t");
-$objPHPExcel = $objReader->load($inputFileName);
+$spreadsheet = $objReader->load($inputFileName);
```
> See Examples/Reader/exampleReader15.php for a working example of this code.
diff --git a/docs/ReadingSpreadsheetFiles/06-Error-Handling.md b/docs/ReadingSpreadsheetFiles/06-Error-Handling.md
index d3e064f9..fcb3b96b 100644
--- a/docs/ReadingSpreadsheetFiles/06-Error-Handling.md
+++ b/docs/ReadingSpreadsheetFiles/06-Error-Handling.md
@@ -1,18 +1,18 @@
-# PHPExcel User Documentation – Reading Spreadsheet Files
+# PhpSpreadsheet User Documentation – Reading Spreadsheet Files
## Error Handling
-Of course, you should always apply some error handling to your scripts as well. PHPExcel throws exceptions, so you can wrap all your code that accesses the library methods within Try/Catch blocks to trap for any problems that are encountered, and deal with them in an appropriate manner.
+Of course, you should always apply some error handling to your scripts as well. PhpSpreadsheet throws exceptions, so you can wrap all your code that accesses the library methods within Try/Catch blocks to trap for any problems that are encountered, and deal with them in an appropriate manner.
-The PHPExcel Readers throw a PHPExcel_Reader_Exception.
+The PhpSpreadsheet Readers throw a \PhpOffice\PhpSpreadsheet\Reader\Exception.
```php
$inputFileName = './sampleData/example-1.xls';
try {
- /** Load $inputFileName to a PHPExcel Object **/
- $objPHPExcel = PHPExcel_IOFactory::load($inputFileName);
-} catch(PHPExcel_Reader_Exception $e) {
+ /** Load $inputFileName to a Spreadsheet Object **/
+ $spreadsheet = \PhpOffice\PhpSpreadsheet\IOFactory::load($inputFileName);
+} catch(\PhpOffice\PhpSpreadsheet\Reader\Exception $e) {
die('Error loading file: '.$e->getMessage());
}
```
diff --git a/docs/ReadingSpreadsheetFiles/07-Helper-Methods.md b/docs/ReadingSpreadsheetFiles/07-Helper-Methods.md
index 57dbec7a..d1f1edb0 100644
--- a/docs/ReadingSpreadsheetFiles/07-Helper-Methods.md
+++ b/docs/ReadingSpreadsheetFiles/07-Helper-Methods.md
@@ -1,4 +1,4 @@
-# PHPExcel User Documentation – Reading Spreadsheet Files
+# PhpSpreadsheet User Documentation – Reading Spreadsheet Files
## Helper Methods
@@ -10,7 +10,7 @@ You can retrieve a list of worksheet names contained in a file without loading t
The `listWorksheetNames()` method returns a simple array listing each worksheet name within the workbook:
```php
-$objReader = PHPExcel_IOFactory::createReader($inputFileType);
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
$worksheetNames = $objReader->listWorksheetNames($inputFileName);
@@ -28,7 +28,7 @@ echo '';
The `listWorksheetInfo()` method returns a nested array, with each entry listing the name and dimensions for a worksheet:
```php
-$objReader = PHPExcel_IOFactory::createReader($inputFileType);
+$objReader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
$worksheetData = $objReader->listWorksheetInfo($inputFileName);