sampleSpreadsheet.php 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373
  1. <?php
  2. // Create new Spreadsheet object
  3. use PhpOffice\PhpSpreadsheet\RichText\RichText;
  4. use PhpOffice\PhpSpreadsheet\Shared\Date;
  5. use PhpOffice\PhpSpreadsheet\Spreadsheet;
  6. use PhpOffice\PhpSpreadsheet\Style\Alignment;
  7. use PhpOffice\PhpSpreadsheet\Style\Border;
  8. use PhpOffice\PhpSpreadsheet\Style\Color;
  9. use PhpOffice\PhpSpreadsheet\Style\Fill;
  10. use PhpOffice\PhpSpreadsheet\Style\Font;
  11. use PhpOffice\PhpSpreadsheet\Style\NumberFormat;
  12. use PhpOffice\PhpSpreadsheet\Style\Protection;
  13. use PhpOffice\PhpSpreadsheet\Worksheet\Drawing;
  14. use PhpOffice\PhpSpreadsheet\Worksheet\PageSetup;
  15. $helper->log('Create new Spreadsheet object');
  16. $spreadsheet = new Spreadsheet();
  17. // Set document properties
  18. $helper->log('Set document properties');
  19. $spreadsheet->getProperties()->setCreator('Maarten Balliauw')
  20. ->setLastModifiedBy('Maarten Balliauw')
  21. ->setTitle('Office 2007 XLSX Test Document')
  22. ->setSubject('Office 2007 XLSX Test Document')
  23. ->setDescription('Test document for Office 2007 XLSX, generated using PHP classes.')
  24. ->setKeywords('office 2007 openxml php')
  25. ->setCategory('Test result file');
  26. // Create a first sheet, representing sales data
  27. $helper->log('Add some data');
  28. $spreadsheet->setActiveSheetIndex(0);
  29. $spreadsheet->getActiveSheet()->setCellValue('B1', 'Invoice');
  30. $date = new DateTime('now');
  31. $date->setTime(0, 0, 0);
  32. $spreadsheet->getActiveSheet()->setCellValue('D1', Date::PHPToExcel($date));
  33. $spreadsheet->getActiveSheet()->getStyle('D1')->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_DATE_XLSX15);
  34. $spreadsheet->getActiveSheet()->setCellValue('E1', '#12566');
  35. $spreadsheet->getActiveSheet()->setCellValue('A3', 'Product Id');
  36. $spreadsheet->getActiveSheet()->setCellValue('B3', 'Description');
  37. $spreadsheet->getActiveSheet()->setCellValue('C3', 'Price');
  38. $spreadsheet->getActiveSheet()->setCellValue('D3', 'Amount');
  39. $spreadsheet->getActiveSheet()->setCellValue('E3', 'Total');
  40. $spreadsheet->getActiveSheet()->setCellValue('A4', '1001');
  41. $spreadsheet->getActiveSheet()->setCellValue('B4', 'PHP for dummies');
  42. $spreadsheet->getActiveSheet()->setCellValue('C4', '20');
  43. $spreadsheet->getActiveSheet()->setCellValue('D4', '1');
  44. $spreadsheet->getActiveSheet()->setCellValue('E4', '=IF(D4<>"",C4*D4,"")');
  45. $spreadsheet->getActiveSheet()->setCellValue('A5', '1012');
  46. $spreadsheet->getActiveSheet()->setCellValue('B5', 'OpenXML for dummies');
  47. $spreadsheet->getActiveSheet()->setCellValue('C5', '22');
  48. $spreadsheet->getActiveSheet()->setCellValue('D5', '2');
  49. $spreadsheet->getActiveSheet()->setCellValue('E5', '=IF(D5<>"",C5*D5,"")');
  50. $spreadsheet->getActiveSheet()->setCellValue('E6', '=IF(D6<>"",C6*D6,"")');
  51. $spreadsheet->getActiveSheet()->setCellValue('E7', '=IF(D7<>"",C7*D7,"")');
  52. $spreadsheet->getActiveSheet()->setCellValue('E8', '=IF(D8<>"",C8*D8,"")');
  53. $spreadsheet->getActiveSheet()->setCellValue('E9', '=IF(D9<>"",C9*D9,"")');
  54. $spreadsheet->getActiveSheet()->setCellValue('D11', 'Total excl.:');
  55. $spreadsheet->getActiveSheet()->setCellValue('E11', '=SUM(E4:E9)');
  56. $spreadsheet->getActiveSheet()->setCellValue('D12', 'VAT:');
  57. $spreadsheet->getActiveSheet()->setCellValue('E12', '=E11*0.21');
  58. $spreadsheet->getActiveSheet()->setCellValue('D13', 'Total incl.:');
  59. $spreadsheet->getActiveSheet()->setCellValue('E13', '=E11+E12');
  60. // Add comment
  61. $helper->log('Add comments');
  62. $spreadsheet->getActiveSheet()->getComment('E11')->setAuthor('PhpSpreadsheet');
  63. $commentRichText = $spreadsheet->getActiveSheet()->getComment('E11')->getText()->createTextRun('PhpSpreadsheet:');
  64. $commentRichText->getFont()->setBold(true);
  65. $spreadsheet->getActiveSheet()->getComment('E11')->getText()->createTextRun("\r\n");
  66. $spreadsheet->getActiveSheet()->getComment('E11')->getText()->createTextRun('Total amount on the current invoice, excluding VAT.');
  67. $spreadsheet->getActiveSheet()->getComment('E12')->setAuthor('PhpSpreadsheet');
  68. $commentRichText = $spreadsheet->getActiveSheet()->getComment('E12')->getText()->createTextRun('PhpSpreadsheet:');
  69. $commentRichText->getFont()->setBold(true);
  70. $spreadsheet->getActiveSheet()->getComment('E12')->getText()->createTextRun("\r\n");
  71. $spreadsheet->getActiveSheet()->getComment('E12')->getText()->createTextRun('Total amount of VAT on the current invoice.');
  72. $spreadsheet->getActiveSheet()->getComment('E13')->setAuthor('PhpSpreadsheet');
  73. $commentRichText = $spreadsheet->getActiveSheet()->getComment('E13')->getText()->createTextRun('PhpSpreadsheet:');
  74. $commentRichText->getFont()->setBold(true);
  75. $spreadsheet->getActiveSheet()->getComment('E13')->getText()->createTextRun("\r\n");
  76. $spreadsheet->getActiveSheet()->getComment('E13')->getText()->createTextRun('Total amount on the current invoice, including VAT.');
  77. $spreadsheet->getActiveSheet()->getComment('E13')->setWidth('100pt');
  78. $spreadsheet->getActiveSheet()->getComment('E13')->setHeight('100pt');
  79. $spreadsheet->getActiveSheet()->getComment('E13')->setMarginLeft('150pt');
  80. $spreadsheet->getActiveSheet()->getComment('E13')->getFillColor()->setRGB('EEEEEE');
  81. // Add rich-text string
  82. $helper->log('Add rich-text string');
  83. $richText = new RichText();
  84. $richText->createText('This invoice is ');
  85. $payable = $richText->createTextRun('payable within thirty days after the end of the month');
  86. $payable->getFont()->setBold(true);
  87. $payable->getFont()->setItalic(true);
  88. $payable->getFont()->setColor(new Color(Color::COLOR_DARKGREEN));
  89. $richText->createText(', unless specified otherwise on the invoice.');
  90. $spreadsheet->getActiveSheet()->getCell('A18')->setValue($richText);
  91. // Merge cells
  92. $helper->log('Merge cells');
  93. $spreadsheet->getActiveSheet()->mergeCells('A18:E22');
  94. $spreadsheet->getActiveSheet()->mergeCells('A28:B28'); // Just to test...
  95. $spreadsheet->getActiveSheet()->unmergeCells('A28:B28'); // Just to test...
  96. // Protect cells
  97. $helper->log('Protect cells');
  98. $spreadsheet->getActiveSheet()->getProtection()->setSheet(true); // Needs to be set to true in order to enable any worksheet protection!
  99. $spreadsheet->getActiveSheet()->protectCells('A3:E13', 'PhpSpreadsheet');
  100. // Set cell number formats
  101. $helper->log('Set cell number formats');
  102. $spreadsheet->getActiveSheet()->getStyle('E4:E13')->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_CURRENCY_EUR_SIMPLE);
  103. // Set column widths
  104. $helper->log('Set column widths');
  105. $spreadsheet->getActiveSheet()->getColumnDimension('B')->setAutoSize(true);
  106. $spreadsheet->getActiveSheet()->getColumnDimension('D')->setWidth(12);
  107. $spreadsheet->getActiveSheet()->getColumnDimension('E')->setWidth(12);
  108. // Set fonts
  109. $helper->log('Set fonts');
  110. $spreadsheet->getActiveSheet()->getStyle('B1')->getFont()->setName('Candara');
  111. $spreadsheet->getActiveSheet()->getStyle('B1')->getFont()->setSize(20);
  112. $spreadsheet->getActiveSheet()->getStyle('B1')->getFont()->setBold(true);
  113. $spreadsheet->getActiveSheet()->getStyle('B1')->getFont()->setUnderline(Font::UNDERLINE_SINGLE);
  114. $spreadsheet->getActiveSheet()->getStyle('B1')->getFont()->getColor()->setARGB(Color::COLOR_WHITE);
  115. $spreadsheet->getActiveSheet()->getStyle('D1')->getFont()->getColor()->setARGB(Color::COLOR_WHITE);
  116. $spreadsheet->getActiveSheet()->getStyle('E1')->getFont()->getColor()->setARGB(Color::COLOR_WHITE);
  117. $spreadsheet->getActiveSheet()->getStyle('D13')->getFont()->setBold(true);
  118. $spreadsheet->getActiveSheet()->getStyle('E13')->getFont()->setBold(true);
  119. // Set alignments
  120. $helper->log('Set alignments');
  121. $spreadsheet->getActiveSheet()->getStyle('D11')->getAlignment()->setHorizontal(Alignment::HORIZONTAL_RIGHT);
  122. $spreadsheet->getActiveSheet()->getStyle('D12')->getAlignment()->setHorizontal(Alignment::HORIZONTAL_RIGHT);
  123. $spreadsheet->getActiveSheet()->getStyle('D13')->getAlignment()->setHorizontal(Alignment::HORIZONTAL_RIGHT);
  124. $spreadsheet->getActiveSheet()->getStyle('A18')->getAlignment()->setHorizontal(Alignment::HORIZONTAL_JUSTIFY);
  125. $spreadsheet->getActiveSheet()->getStyle('A18')->getAlignment()->setVertical(Alignment::VERTICAL_CENTER);
  126. $spreadsheet->getActiveSheet()->getStyle('B5')->getAlignment()->setShrinkToFit(true);
  127. // Set thin black border outline around column
  128. $helper->log('Set thin black border outline around column');
  129. $styleThinBlackBorderOutline = [
  130. 'borders' => [
  131. 'outline' => [
  132. 'borderStyle' => Border::BORDER_THIN,
  133. 'color' => ['argb' => 'FF000000'],
  134. ],
  135. ],
  136. ];
  137. $spreadsheet->getActiveSheet()->getStyle('A4:E10')->applyFromArray($styleThinBlackBorderOutline);
  138. // Set thick brown border outline around "Total"
  139. $helper->log('Set thick brown border outline around Total');
  140. $styleThickBrownBorderOutline = [
  141. 'borders' => [
  142. 'outline' => [
  143. 'borderStyle' => Border::BORDER_THICK,
  144. 'color' => ['argb' => 'FF993300'],
  145. ],
  146. ],
  147. ];
  148. $spreadsheet->getActiveSheet()->getStyle('D13:E13')->applyFromArray($styleThickBrownBorderOutline);
  149. // Set fills
  150. $helper->log('Set fills');
  151. $spreadsheet->getActiveSheet()->getStyle('A1:E1')->getFill()->setFillType(Fill::FILL_SOLID);
  152. $spreadsheet->getActiveSheet()->getStyle('A1:E1')->getFill()->getStartColor()->setARGB('FF808080');
  153. // Set style for header row using alternative method
  154. $helper->log('Set style for header row using alternative method');
  155. $spreadsheet->getActiveSheet()->getStyle('A3:E3')->applyFromArray(
  156. [
  157. 'font' => [
  158. 'bold' => true,
  159. ],
  160. 'alignment' => [
  161. 'horizontal' => Alignment::HORIZONTAL_RIGHT,
  162. ],
  163. 'borders' => [
  164. 'top' => [
  165. 'borderStyle' => Border::BORDER_THIN,
  166. ],
  167. ],
  168. 'fill' => [
  169. 'fillType' => Fill::FILL_GRADIENT_LINEAR,
  170. 'rotation' => 90,
  171. 'startColor' => [
  172. 'argb' => 'FFA0A0A0',
  173. ],
  174. 'endColor' => [
  175. 'argb' => 'FFFFFFFF',
  176. ],
  177. ],
  178. ]
  179. );
  180. $spreadsheet->getActiveSheet()->getStyle('A3')->applyFromArray(
  181. [
  182. 'alignment' => [
  183. 'horizontal' => Alignment::HORIZONTAL_LEFT,
  184. ],
  185. 'borders' => [
  186. 'left' => [
  187. 'borderStyle' => Border::BORDER_THIN,
  188. ],
  189. ],
  190. ]
  191. );
  192. $spreadsheet->getActiveSheet()->getStyle('B3')->applyFromArray(
  193. [
  194. 'alignment' => [
  195. 'horizontal' => Alignment::HORIZONTAL_LEFT,
  196. ],
  197. ]
  198. );
  199. $spreadsheet->getActiveSheet()->getStyle('E3')->applyFromArray(
  200. [
  201. 'borders' => [
  202. 'right' => [
  203. 'borderStyle' => Border::BORDER_THIN,
  204. ],
  205. ],
  206. ]
  207. );
  208. // Unprotect a cell
  209. $helper->log('Unprotect a cell');
  210. $spreadsheet->getActiveSheet()->getStyle('B1')->getProtection()->setLocked(Protection::PROTECTION_UNPROTECTED);
  211. // Add a hyperlink to the sheet
  212. $helper->log('Add a hyperlink to an external website');
  213. $spreadsheet->getActiveSheet()->setCellValue('E26', 'www.phpexcel.net');
  214. $spreadsheet->getActiveSheet()->getCell('E26')->getHyperlink()->setUrl('https://www.example.com');
  215. $spreadsheet->getActiveSheet()->getCell('E26')->getHyperlink()->setTooltip('Navigate to website');
  216. $spreadsheet->getActiveSheet()->getStyle('E26')->getAlignment()->setHorizontal(Alignment::HORIZONTAL_RIGHT);
  217. $helper->log('Add a hyperlink to another cell on a different worksheet within the workbook');
  218. $spreadsheet->getActiveSheet()->setCellValue('E27', 'Terms and conditions');
  219. $spreadsheet->getActiveSheet()->getCell('E27')->getHyperlink()->setUrl("sheet://'Terms and conditions'!A1");
  220. $spreadsheet->getActiveSheet()->getCell('E27')->getHyperlink()->setTooltip('Review terms and conditions');
  221. $spreadsheet->getActiveSheet()->getStyle('E27')->getAlignment()->setHorizontal(Alignment::HORIZONTAL_RIGHT);
  222. // Add a drawing to the worksheet
  223. $helper->log('Add a drawing to the worksheet');
  224. $drawing = new Drawing();
  225. $drawing->setName('Logo');
  226. $drawing->setDescription('Logo');
  227. $drawing->setPath(__DIR__ . '/../images/officelogo.jpg');
  228. $drawing->setHeight(36);
  229. $drawing->setWorksheet($spreadsheet->getActiveSheet());
  230. // Add a drawing to the worksheet
  231. $helper->log('Add a drawing to the worksheet');
  232. $drawing = new Drawing();
  233. $drawing->setName('Paid');
  234. $drawing->setDescription('Paid');
  235. $drawing->setPath(__DIR__ . '/../images/paid.png');
  236. $drawing->setCoordinates('B15');
  237. $drawing->setOffsetX(110);
  238. $drawing->setRotation(25);
  239. $drawing->getShadow()->setVisible(true);
  240. $drawing->getShadow()->setDirection(45);
  241. $drawing->setWorksheet($spreadsheet->getActiveSheet());
  242. // Add a drawing to the worksheet
  243. $helper->log('Add a drawing to the worksheet');
  244. $drawing = new Drawing();
  245. $drawing->setName('PhpSpreadsheet logo');
  246. $drawing->setDescription('PhpSpreadsheet logo');
  247. $drawing->setPath(__DIR__ . '/../images/PhpSpreadsheet_logo.png');
  248. $drawing->setHeight(36);
  249. $drawing->setCoordinates('D24');
  250. $drawing->setOffsetX(10);
  251. $drawing->setWorksheet($spreadsheet->getActiveSheet());
  252. // Play around with inserting and removing rows and columns
  253. $helper->log('Play around with inserting and removing rows and columns');
  254. $spreadsheet->getActiveSheet()->insertNewRowBefore(6, 10);
  255. $spreadsheet->getActiveSheet()->removeRow(6, 10);
  256. $spreadsheet->getActiveSheet()->insertNewColumnBefore('E', 5);
  257. $spreadsheet->getActiveSheet()->removeColumn('E', 5);
  258. // Set header and footer. When no different headers for odd/even are used, odd header is assumed.
  259. $helper->log('Set header/footer');
  260. $spreadsheet->getActiveSheet()->getHeaderFooter()->setOddHeader('&L&BInvoice&RPrinted on &D');
  261. $spreadsheet->getActiveSheet()->getHeaderFooter()->setOddFooter('&L&B' . $spreadsheet->getProperties()->getTitle() . '&RPage &P of &N');
  262. // Set page orientation and size
  263. $helper->log('Set page orientation and size');
  264. $spreadsheet->getActiveSheet()->getPageSetup()->setOrientation(PageSetup::ORIENTATION_PORTRAIT);
  265. $spreadsheet->getActiveSheet()->getPageSetup()->setPaperSize(PageSetup::PAPERSIZE_A4);
  266. // Rename first worksheet
  267. $helper->log('Rename first worksheet');
  268. $spreadsheet->getActiveSheet()->setTitle('Invoice');
  269. // Create a new worksheet, after the default sheet
  270. $helper->log('Create a second Worksheet object');
  271. $spreadsheet->createSheet();
  272. // Llorem ipsum...
  273. $sLloremIpsum = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Vivamus eget ante. Sed cursus nunc semper tortor. Aliquam luctus purus non elit. Fusce vel elit commodo sapien dignissim dignissim. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Curabitur accumsan magna sed massa. Nullam bibendum quam ac ipsum. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin augue. Praesent malesuada justo sed orci. Pellentesque lacus ligula, sodales quis, ultricies a, ultricies vitae, elit. Sed luctus consectetuer dolor. Vivamus vel sem ut nisi sodales accumsan. Nunc et felis. Suspendisse semper viverra odio. Morbi at odio. Integer a orci a purus venenatis molestie. Nam mattis. Praesent rhoncus, nisi vel mattis auctor, neque nisi faucibus sem, non dapibus elit pede ac nisl. Cras turpis.';
  274. // Add some data to the second sheet, resembling some different data types
  275. $helper->log('Add some data');
  276. $spreadsheet->setActiveSheetIndex(1);
  277. $spreadsheet->getActiveSheet()->setCellValue('A1', 'Terms and conditions');
  278. $spreadsheet->getActiveSheet()->setCellValue('A3', $sLloremIpsum);
  279. $spreadsheet->getActiveSheet()->setCellValue('A4', $sLloremIpsum);
  280. $spreadsheet->getActiveSheet()->setCellValue('A5', $sLloremIpsum);
  281. $spreadsheet->getActiveSheet()->setCellValue('A6', $sLloremIpsum);
  282. // Set the worksheet tab color
  283. $helper->log('Set the worksheet tab color');
  284. $spreadsheet->getActiveSheet()->getTabColor()->setARGB('FF0094FF');
  285. // Set alignments
  286. $helper->log('Set alignments');
  287. $spreadsheet->getActiveSheet()->getStyle('A3:A6')->getAlignment()->setWrapText(true);
  288. // Set column widths
  289. $helper->log('Set column widths');
  290. $spreadsheet->getActiveSheet()->getColumnDimension('A')->setWidth(80);
  291. // Set fonts
  292. $helper->log('Set fonts');
  293. $spreadsheet->getActiveSheet()->getStyle('A1')->getFont()->setName('Candara');
  294. $spreadsheet->getActiveSheet()->getStyle('A1')->getFont()->setSize(20);
  295. $spreadsheet->getActiveSheet()->getStyle('A1')->getFont()->setBold(true);
  296. $spreadsheet->getActiveSheet()->getStyle('A1')->getFont()->setUnderline(Font::UNDERLINE_SINGLE);
  297. $spreadsheet->getActiveSheet()->getStyle('A3:A6')->getFont()->setSize(8);
  298. // Add a drawing to the worksheet
  299. $helper->log('Add a drawing to the worksheet');
  300. $drawing = new Drawing();
  301. $drawing->setName('Terms and conditions');
  302. $drawing->setDescription('Terms and conditions');
  303. $drawing->setPath(__DIR__ . '/../images/termsconditions.jpg');
  304. $drawing->setCoordinates('B14');
  305. $drawing->setWorksheet($spreadsheet->getActiveSheet());
  306. // Set page orientation and size
  307. $helper->log('Set page orientation and size');
  308. $spreadsheet->getActiveSheet()->getPageSetup()->setOrientation(PageSetup::ORIENTATION_LANDSCAPE);
  309. $spreadsheet->getActiveSheet()->getPageSetup()->setPaperSize(PageSetup::PAPERSIZE_A4);
  310. // Rename second worksheet
  311. $helper->log('Rename second worksheet');
  312. $spreadsheet->getActiveSheet()->setTitle('Terms and conditions');
  313. // Set active sheet index to the first sheet, so Excel opens this as the first sheet
  314. $spreadsheet->setActiveSheetIndex(0);
  315. return $spreadsheet;