Add setCellVerticalAlignment() & allow setShouldWrapText() to be expl…

…icitly set as false - add Common\Entity\Style\CellVerticalAlignment - duplicate get/set/hasSet/shouldApply methods for CellAlignment in Common\Entity\Style\Style for CellVerticalAlignment instead, plus corresponding properties - add setCellVerticalAlignment method to Common\Creator\Style\StyleBuilder - add vertical alignment to StyleMerger:: mergeCellProperties() - adjust wrapText logic in mergeCellProperties() to fix issue box/spout#829 - apply vertical cell styling for both XLSX and ODS, via corresponding StyleManager classes - transform vertical alignment ‘center’ to ‘middle’ for ODS - fix logic around wrapText such that the choice whether to include wrapping styles depends on hasSetWrapText() being true, and then use shouldWrapText() thereafter to either set wrapping or no wrapping (for XLSX, wrapText=“1” or wrapText=“0”, for ODS, wrap-option=wrap or wrap-option=no-wrap). previously there was no way to set wrapping to be OFF, only to set it to be ON. - add new tests to ensure shouldWrapText(false) results in the correct negated wrapText (XLSX) / wrap-option (ODS) styles - add new tests to StyleBuilderTest for vertical alignment - add vertical alignment to documentation.md
Slamdunk · Mar 28, 2022 · bb8fbef · bb8fbef
1 parent 212126b
commit bb8fbef
Show file tree

Hide file tree

Showing 9 changed files with 490 additions and 10 deletions.
diff --git a/docs/_pages/documentation.md b/docs/_pages/documentation.md
@@ -0,0 +1,325 @@
+---
+layout: doc
+title: Documentation
+permalink: /docs/
+---
+
+## Configuration for CSV
+
+It is possible to configure both the CSV reader and writer to adapt them to your requirements:
+
+```php
+use Box\Spout\Reader\Common\Creator\ReaderEntityFactory;
+
+$reader = ReaderEntityFactory::createReaderFromFile('/path/to/file.csv');
+/** All of these methods have to be called before opening the reader. */
+$reader->setFieldDelimiter('|');
+$reader->setFieldEnclosure('@');
+
+```
+
+Additionally, if you need to read non UTF-8 files, you can specify the encoding of your file this way:
+
+```php
+$reader->setEncoding('UTF-16LE');
+```
+
+By default, the writer generates CSV files encoded in UTF-8, with a BOM.
+It is however possible to not include the BOM:
+
+```php
+use Box\Spout\Writer\Common\Creator\WriterEntityFactory;
+
+$writer = WriterEntityFactory::createWriterFromFile('/path/to/file.csv');
+$writer->setShouldAddBOM(false);
+```
+
+
+## Configuration for XLSX and ODS
+
+### New sheet creation
+
+It is possible to change the behavior of the writers when the maximum number of rows (*1,048,576*) has been written in the current sheet. By default, a new sheet is automatically created so that writing can keep going but that may not always be preferable.
+
+```php
+
+use Box\Spout\Writer\Common\Creator\WriterEntityFactory;
+
+$writer = WriterEntityFactory::createODSWriter();
+$writer->setShouldCreateNewSheetsAutomatically(true); // default value
+$writer->setShouldCreateNewSheetsAutomatically(false); // will stop writing new data when limit is reached
+```
+
+### Using a custom temporary folder
+
+Processing XLSX and ODS files requires temporary files to be created. By default, {{ site.spout_html }} will use the system default temporary folder (as returned by `sys_get_temp_dir()`). It is possible to override this by explicitly setting it on the reader or writer:
+
+```php
+use Box\Spout\Writer\Common\Creator\WriterEntityFactory;
+
+$writer = WriterEntityFactory::createXLSXWriter();
+$writer->setTempFolder($customTempFolderPath);
+```
+
+### Strings storage (XLSX writer)
+
+XLSX files support different ways to store the string values:
+* Shared strings are meant to optimize file size by separating strings from the sheet representation and ignoring strings duplicates (if a string is used three times, only one string will be stored)
+* Inline strings are less optimized (as duplicate strings are all stored) but is faster to process
+
+In order to keep the memory usage really low, {{ site.spout_html }} does not de-duplicate strings when using shared strings. It is nevertheless possible to use this mode.
+
+```php
+use Box\Spout\Writer\Common\Creator\WriterEntityFactory;
+
+$writer = WriterEntityFactory::createXLSXWriter();
+$writer->setShouldUseInlineStrings(true); // default (and recommended) value
+$writer->setShouldUseInlineStrings(false); // will use shared strings
+```
+
+> #### Note on Apple Numbers and iOS support
+>
+> Apple's products (Numbers and the iOS previewer) don't support inline strings and display empty cells instead. Therefore, if these platforms need to be supported, make sure to use shared strings!
+
+### Date/Time formatting
+
+When reading a spreadsheet containing dates or times, {{ site.spout_html }} returns the values by default as `DateTime` objects.
+It is possible to change this behavior and have a formatted date returned instead (e.g. "2016-11-29 1:22 AM"). The format of the date corresponds to what is specified in the spreadsheet.
+
+```php
+use Box\Spout\Reader\Common\Creator\ReaderEntityFactory;
+
+$reader = ReaderEntityFactory::createXLSXReader();
+$reader->setShouldFormatDates(false); // default value
+$reader->setShouldFormatDates(true); // will return formatted dates
+```
+
+
+## Empty rows
+
+By default, when {{ site.spout_html }} reads a spreadsheet it skips empty rows and only return rows containing data.
+This behavior can be changed so that {{ site.spout_html }} returns all rows:
+
+```php
+use Box\Spout\Reader\Common\Creator\ReaderEntityFactory;
+
+$reader = ReaderEntityFactory::createReaderFromFile('/path/to/file.ext');
+$reader->setShouldPreserveEmptyRows(true);
+```
+
+
+## Styling
+
+### Available styles
+
+{{ site.spout_html }} supports styling at a row and cell level. It is possible to customize the fonts, backgrounds, alignment as well as borders.
+
+For fonts and alignments, {{ site.spout_html }} does not support all the possible formatting options yet. But you can find the most important ones:
+
+| Category             | Property                | API
+|:---------------------|:------------------------|:--------------------------------------
+| Font                 | Bold                    | `StyleBuilder::setFontBold()`
+|                      | Italic                  | `StyleBuilder::setFontItalic()`
+|                      | Underline               | `StyleBuilder::setFontUnderline()`
+|                      | Strikethrough           | `StyleBuilder::setFontStrikethrough()`
+|                      | Font name               | `StyleBuilder::setFontName('Arial')`
+|                      | Font size               | `StyleBuilder::setFontSize(14)`
+|                      | Font color              | `StyleBuilder::setFontColor(Color::BLUE)`<br>`StyleBuilder::setFontColor(Color::rgb(0, 128, 255))`
+| Alignment            | Cell alignment          | `StyleBuilder::setCellAlignment(CellAlignment::CENTER)`
+|                      | Cell vertical alignment | `StyleBuilder::setCellVerticalAlignment(CellVerticalAlignment::CENTER)`
+|                      | Wrap text               | `StyleBuilder::setShouldWrapText(true)`
+| Format _(XLSX only)_ | Number format           | `StyleBuilder::setFormat('0.000')`
+|                      | Date format             | `StyleBuilder::setFormat('m/d/yy h:mm')`
+
+### Styling rows
+
+It is possible to apply some formatting options to a row. In this case, all cells of the row will have the same style:
+
+```php
+use Box\Spout\Writer\Common\Creator\WriterEntityFactory;
+use Box\Spout\Writer\Common\Creator\Style\StyleBuilder;
+use Box\Spout\Common\Entity\Style\CellAlignment;
+use Box\Spout\Common\Entity\Style\Color;
+
+$writer = WriterEntityFactory::createXLSXWriter();
+$writer->openToFile($filePath);
+
+/** Create a style with the StyleBuilder */
+$style = (new StyleBuilder())
+           ->setFontBold()
+           ->setFontSize(15)
+           ->setFontColor(Color::BLUE)
+           ->setShouldWrapText()
+           ->setCellAlignment(CellAlignment::RIGHT)
+           ->setCellVerticalAlignment(CellVerticalAlignment::BOTTOM)
+           ->setBackgroundColor(Color::YELLOW)
+           ->build();
+
+/** Create a row with cells and apply the style to all cells */
+$row = WriterEntityFactory::createRowFromArray(['Carl', 'is', 'great'], $style);
+
+/** Add the row to the writer */
+$writer->addRow($row);
+$writer->close();
+```
+
+Adding borders to a row requires a ```Border``` object.
+
+```php
+use Box\Spout\Common\Entity\Style\Border;
+use Box\Spout\Writer\Common\Creator\Style\BorderBuilder;
+use Box\Spout\Common\Entity\Style\Color;
+use Box\Spout\Writer\Common\Creator\Style\StyleBuilder;
+use Box\Spout\Writer\Common\Creator\WriterEntityFactory;
+
+$border = (new BorderBuilder())
+    ->setBorderBottom(Color::GREEN, Border::WIDTH_THIN, Border::STYLE_DASHED)
+    ->build();
+
+$style = (new StyleBuilder())
+    ->setBorder($border)
+    ->build();
+
+$writer = WriterEntityFactory::createXLSXWriter();
+$writer->openToFile($filePath);
+
+$cells = WriterEntityFactory::createCell('Border Bottom Green Thin Dashed');
+$row = WriterEntityFactory::createRow($cells);
+$row->setStyle($style);
+$writer->addRow($row);
+
+$writer->close();
+```
+
+### Styling cells
+
+The same styling techniques as described in [Styling rows](#styling-rows) can be applied to individual cells of a row as well.
+
+Cell styles are inherited from the parent row and the default row style respectively.
+
+The styles applied to a specific cell will override any parent styles if present.
+
+Example:
+
+```php
+use Box\Spout\Common\Entity\Style\Color;
+use Box\Spout\Writer\Common\Creator\Style\StyleBuilder;
+use Box\Spout\Writer\Common\Creator\WriterEntityFactory;
+
+$defaultStyle = (new StyleBuilder())
+    ->setFontSize(8)
+    ->build();
+
+$writer = WriterEntityFactory::createXLSXWriter();
+$writer->setDefaultRowStyle($defaultStyle)
+    ->openToFile($filePath);
+
+$zebraBlackStyle = (new StyleBuilder())
+    ->setBackgroundColor(Color::BLACK)
+    ->setFontColor(Color::WHITE)
+    ->setFontSize(10)
+    ->build();
+
+$zebraWhiteStyle = (new StyleBuilder())
+    ->setBackgroundColor(Color::WHITE)
+    ->setFontColor(Color::BLACK)
+    ->setFontItalic()
+    ->build();  
+
+$cells = [
+    WriterEntityFactory::createCell('Ze', $zebraBlackStyle),
+    WriterEntityFactory::createCell('bra', $zebraWhiteStyle)
+];
+
+$rowStyle = (new StyleBuilder())
+    ->setFontBold()
+    ->build();
+
+$row = WriterEntityFactory::createRow($cells, $rowStyle);
+
+$writer->addRow($row);
+$writer->close();
+```
+
+### Default style
+
+{{ site.spout_html }} will use a default style for all created rows. This style can be overridden this way:
+
+```php
+$defaultStyle = (new StyleBuilder())
+                ->setFontName('Arial')
+                ->setFontSize(11)
+                ->build();
+
+$writer = WriterEntityFactory::createXLSXWriter();
+$writer->setDefaultRowStyle($defaultStyle)
+       ->openToFile($filePath);
+```
+
+
+## Playing with sheets
+
+When creating a XLSX or ODS file, it is possible to control which sheet the data will be written into. At any time, you can retrieve or set the current sheet:
+
+```php
+$firstSheet = $writer->getCurrentSheet();
+$writer->addRow($rowForSheet1); // writes the row to the first sheet
+
+$newSheet = $writer->addNewSheetAndMakeItCurrent();
+$writer->addRow($rowForSheet2); // writes the row to the new sheet
+
+$writer->setCurrentSheet($firstSheet);
+$writer->addRow($anotherRowForSheet1); // append the row to the first sheet
+```
+
+It is also possible to retrieve all the sheets currently created:
+```php
+$sheets = $writer->getSheets();
+```
+
+It is possible to retrieve some sheet's attributes when reading:
+```php
+foreach ($reader->getSheetIterator() as $sheet) {
+    $sheetName = $sheet->getName();
+    $isSheetVisible = $sheet->isVisible();
+    $isSheetActive = $sheet->isActive(); // active sheet when spreadsheet last saved
+}
+```
+
+If you rely on the sheet's name in your application, you can customize it this way:
+
+```php
+// Accessing the sheet name when writing
+$sheet = $writer->getCurrentSheet();
+$sheetName = $sheet->getName();
+
+// Customizing the sheet name when writing
+$sheet = $writer->getCurrentSheet();
+$sheet->setName('My custom name');
+```
+
+> Please note that Excel has some restrictions on the sheet's name:
+> * it must not be blank
+> * it must not exceed 31 characters
+> * it must not contain these characters: \ / ? * : [ or ]
+> * it must not start or end with a single quote
+> * it must be unique
+>
+> Handling these restrictions is the developer's responsibility. {{ site.spout_html }} does not try to automatically change the sheet's name, as one may rely on this name to be exactly what was passed in.
+
+
+## Fluent interface
+
+Because fluent interfaces are great, you can use them with {{ site.spout_html }}:
+
+```php
+use Box\Spout\Writer\WriterEntityFactory;
+
+$writer = WriterEntityFactory::createWriterFromFile('path/to/file.ext');
+$writer->setTempFolder($customTempFolderPath)
+       ->setShouldUseInlineStrings(true)
+       ->openToFile($filePath)
+       ->addRow($headerRow)
+       ->addRows($dataRows)
+       ->close();
+```
diff --git a/src/Common/Entity/Style/CellVerticalAlignment.php b/src/Common/Entity/Style/CellVerticalAlignment.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace Box\Spout\Common\Entity\Style;
+
+/**
+ * Class CellVerticalAlignment
+ * This class provides constants to work with text vertical alignment.
+ */
+abstract class CellVerticalAlignment
+{
+    public const AUTO = 'auto';
+    public const BASELINE = 'baseline';
+    public const BOTTOM = 'bottom';
+    public const CENTER = 'center';
+    public const DISTRIBUTED = 'distributed';
+    public const JUSTIFY = 'justify';
+    public const TOP = 'top';
+
+    private static $VALID_ALIGNMENTS = [
+        self::AUTO => 1,
+        self::BASELINE => 1,
+        self::BOTTOM => 1,
+        self::CENTER => 1,
+        self::DISTRIBUTED => 1,
+        self::JUSTIFY => 1,
+        self::TOP => 1,
+    ];
+
+    /**
+     * @return bool Whether the given cell vertical alignment is valid
+     */
+    public static function isValid(string $cellVerticalAlignment): bool
+    {
+        return isset(self::$VALID_ALIGNMENTS[$cellVerticalAlignment]);
+    }
+}