WebSVN – Moodle – Diff – /lib/openspout/src/Writer/XLSX/Helper/FileSystemHelper.php

 use OpenSpout\Writer\Common\Helper\FileSystemWithRootFolderHelperInterface;
 use OpenSpout\Writer\Common\Helper\ZipHelper;
 use OpenSpout\Writer\XLSX\Manager\Style\StyleManager;
 use OpenSpout\Writer\XLSX\MergeCell;
 use OpenSpout\Writer\XLSX\Options;
+use OpenSpout\Writer\XLSX\Properties;
 /**
  * @internal
  */
     public const WORKSHEETS_FOLDER_NAME = 'worksheets';
     public const RELS_FILE_NAME = '.rels';
     public const APP_XML_FILE_NAME = 'app.xml';
+    public const CORE_XML_FILE_NAME = 'core.xml';
-    public const CORE_XML_FILE_NAME = 'core.xml';
+    public const CUSTOM_XML_FILE_NAME = 'custom.xml';
     public const CONTENT_TYPES_XML_FILE_NAME = '[Content_Types].xml';
     public const WORKBOOK_XML_FILE_NAME = 'workbook.xml';
     public const WORKBOOK_RELS_XML_FILE_NAME = 'workbook.xml.rels';
     private readonly CommonFileSystemHelper $baseFileSystemHelper;
     /** @var ZipHelper Helper to perform tasks with Zip archive */
     private readonly ZipHelper $zipHelper;
-    /** @var string document creator */
+    /** @var Properties document properties */
-    private readonly string $creator;
+    private readonly Properties $properties;
     /** @var string Path to the temp folder, inside the root folder, where specific sheets content will be written to */
     private string $sheetsContentTempFolder;
     /**
-     * @param string    $baseFolderPath The path of the base folder where all the I/O can occur
+     * @param string     $baseFolderPath The path of the base folder where all the I/O can occur
-     * @param ZipHelper $zipHelper      Helper to perform tasks with Zip archive
+     * @param ZipHelper  $zipHelper      Helper to perform tasks with Zip archive
-     * @param XLSX      $escaper        Used to escape XML data
+     * @param XLSX       $escaper        Used to escape XML data
-     * @param string    $creator        document creator
+     * @param Properties $properties     document properies
      */
-    public function __construct(string $baseFolderPath, ZipHelper $zipHelper, XLSX $escaper, string $creator)
+    public function __construct(string $baseFolderPath, ZipHelper $zipHelper, XLSX $escaper, Properties $properties)
+    {
         $this->baseFileSystemHelper = new CommonFileSystemHelper($baseFolderPath);
         $this->baseFolderRealPath = $this->baseFileSystemHelper->getBaseFolderRealPath();
         $this->zipHelper = $zipHelper;
         $this->escaper = $escaper;
-        $this->creator = $creator;
+        $this->properties = $properties;
+    }
             $contentTypesXmlFileContents .= '<Override ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml" PartName="/xl/worksheets/sheet'.$worksheet->getId().'.xml"/>';
             $contentTypesXmlFileContents .= '<Override ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.comments+xml" PartName="/xl/comments'.$worksheet->getId().'.xml" />';
+        }
         $contentTypesXmlFileContents .= <<<'EOD'
-                <Override ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml" PartName="/xl/styles.xml"/>
+            <Override ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml" PartName="/xl/styles.xml"/>
-                <Override ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml" PartName="/xl/sharedStrings.xml"/>
+            <Override ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml" PartName="/xl/sharedStrings.xml"/>
-                <Override ContentType="application/vnd.openxmlformats-package.core-properties+xml" PartName="/docProps/core.xml"/>
+            <Override ContentType="application/vnd.openxmlformats-package.core-properties+xml" PartName="/docProps/core.xml"/>
+            <Override ContentType="application/vnd.openxmlformats-officedocument.extended-properties+xml" PartName="/docProps/app.xml"/>
+            EOD;
+        if ([] !== $this->properties->customProperties) {
+            $contentTypesXmlFileContents .= <<<'EOD'
+                <Override ContentType="application/vnd.openxmlformats-officedocument.custom-properties+xml" PartName="/docProps/custom.xml" />
+                EOD;
+        }
-                <Override ContentType="application/vnd.openxmlformats-officedocument.extended-properties+xml" PartName="/docProps/app.xml"/>
+        $contentTypesXmlFileContents .= <<<'EOD'
             </Types>
             EOD;
     /**
      * Creates the "workbook.xml" file under the "xl" folder.
+     *
      * @param Worksheet[] $worksheets
      */
-    public function createWorkbookFile(array $worksheets): self
+    public function createWorkbookFile(Options $options, array $worksheets): self
+    {
         $workbookXmlFileContents = <<<'EOD'
             <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
             <workbook xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">
+            EOD;
+        if (null !== $options->getWorkbookProtection()) {
+            $workbookXmlFileContents .= $options->getWorkbookProtection()->getXml();
+        }
+        $workbookXmlFileContents .= <<<'EOD'
                 <sheets>
             EOD;
         /** @var Worksheet $worksheet */
         /** @var Worksheet $worksheet */
         foreach ($worksheets as $worksheet) {
             $sheet = $worksheet->getExternalSheet();
             if (null !== $autofilter = $sheet->getAutoFilter()) {
                 $worksheetName = $sheet->getName();
-                $name = sprintf(
+                $name = \sprintf(
                     '\'%s\'!$%s$%s:$%s$%s',
                     $this->escaper->escape($worksheetName),
                     CellHelper::getColumnLettersFromColumnIndex($autofilter->fromColumnIndex),
                     $autofilter->fromRow,
                     CellHelper::getColumnLettersFromColumnIndex($autofilter->toColumnIndex),
             $sheet = $worksheet->getExternalSheet();
             fwrite($worksheetFilePointer, self::SHEET_XML_FILE_HEADER);
             // AutoFilter tags
-            $range = '';
-            if (null !== $autofilter = $sheet->getAutoFilter()) {
-                $range = sprintf(
-                    '%s%s:%s%s',
-                    CellHelper::getColumnLettersFromColumnIndex($autofilter->fromColumnIndex),
-                    $autofilter->fromRow,
-                    CellHelper::getColumnLettersFromColumnIndex($autofilter->toColumnIndex),
-                    $autofilter->toRow
+            // AutoFilter tags
-                );
+            if (null !== $autofilter = $sheet->getAutoFilter()) {
                 if (isset($pageSetup) && $pageSetup->fitToPage) {
                     fwrite($worksheetFilePointer, '<sheetPr filterMode="false"><pageSetUpPr fitToPage="true"/></sheetPr>');
                 } else {
-                    fwrite($worksheetFilePointer, '<sheetPr filterMode="false"><pageSetUpPr fitToPage="false"/></sheetPr>');
                     fwrite($worksheetFilePointer, '<sheetPr filterMode="false"><pageSetUpPr fitToPage="false"/></sheetPr>');
                 fwrite($worksheetFilePointer, sprintf('<dimension ref="%s"/>', $range));
             } elseif (isset($pageSetup) && $pageSetup->fitToPage) {
+                fwrite($worksheetFilePointer, '<sheetPr><pageSetUpPr fitToPage="true"/></sheetPr>');
+            }
+            $sheetRange = \sprintf(
+                '%s%s:%s%s',
+                CellHelper::getColumnLettersFromColumnIndex(0),
+,
+                CellHelper::getColumnLettersFromColumnIndex($worksheet->getMaxNumColumns() - 1),
+                $worksheet->getLastWrittenRowIndex()
-                fwrite($worksheetFilePointer, '<sheetPr><pageSetUpPr fitToPage="true"/></sheetPr>');
+            );
             fwrite($worksheetFilePointer, \sprintf('<dimension ref="%s"/>', $sheetRange));
             if (null !== ($sheetView = $sheet->getSheetView())) {
                 fwrite($worksheetFilePointer, '<sheetViews>'.$sheetView->getXml().'</sheetViews>');
+            }
             $worksheetFilePath = $worksheet->getFilePath();
             $this->copyFileContentsToTarget($worksheetFilePath, $worksheetFilePointer);
+            fwrite($worksheetFilePointer, '</sheetData>');
+            if (null !== $sheet->getSheetProtection()) {
+                fwrite($worksheetFilePointer, $sheet->getSheetProtection()->getXml());
             fwrite($worksheetFilePointer, '</sheetData>');
+            // AutoFilter tag
+            if (null !== $autofilter) {
+                $autoFilterRange = \sprintf(
+                    '%s%s:%s%s',
+                    CellHelper::getColumnLettersFromColumnIndex($autofilter->fromColumnIndex),
+                    $autofilter->fromRow,
+                    CellHelper::getColumnLettersFromColumnIndex($autofilter->toColumnIndex),
-            // AutoFilter tag
+                    $autofilter->toRow
-            if ('' !== $range) {
+                );
-                fwrite($worksheetFilePointer, sprintf('<autoFilter ref="%s"/>', $range));
+                fwrite($worksheetFilePointer, \sprintf('<autoFilter ref="%s"/>', $autoFilterRange));
+            }
             if ([] !== $mergeCells) {
                 $mergeCellString = '<mergeCells count="'.\count($mergeCells).'">';
                 foreach ($mergeCells as $mergeCell) {
                     $topLeft = CellHelper::getColumnLettersFromColumnIndex($mergeCell->topLeftColumn).$mergeCell->topLeftRow;
                     $bottomRight = CellHelper::getColumnLettersFromColumnIndex($mergeCell->bottomRightColumn).$mergeCell->bottomRightRow;
-                    $mergeCellString .= sprintf(
+                    $mergeCellString .= \sprintf(
                         '<mergeCell ref="%s:%s"/>',
                         $topLeft,
                         $bottomRight
                     );
+                }
+     *
      * @throws IOException If unable to create the file
      */
     private function createRelsFile(): self
+    {
+        $relationshipsXmlContents = <<<'EOD'
+            <Relationship Id="rIdWorkbook" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml"/>
+            <Relationship Id="rIdCore" Type="http://schemas.openxmlformats.org/officedocument/2006/relationships/metadata/core-properties" Target="docProps/core.xml"/>
+            <Relationship Id="rIdApp" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties" Target="docProps/app.xml"/>
+            EOD;
+        if ([] !== $this->properties->customProperties) {
+            $relationshipsXmlContents .= <<<'EOD'
+                <Relationship Id="rId4" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties" Target="docProps/custom.xml"/>
+                EOD;
+        }
-        $relsFileContents = <<<'EOD'
+        $relsFileContents = <<<EOD
             <?xml version="1.0" encoding="UTF-8"?>
-            <Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">
+            <Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">{$relationshipsXmlContents}</Relationships>
-                <Relationship Id="rIdWorkbook" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml"/>
-                <Relationship Id="rIdCore" Type="http://schemas.openxmlformats.org/officedocument/2006/relationships/metadata/core-properties" Target="docProps/core.xml"/>
-                <Relationship Id="rIdApp" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties" Target="docProps/app.xml"/>
-            </Relationships>
             EOD;
         $this->createFileWithContents($this->relsFolder, self::RELS_FILE_NAME, $relsFileContents);
         $this->docPropsFolder = $this->createFolder($this->rootFolder, self::DOC_PROPS_FOLDER_NAME);
         $this->createAppXmlFile();
+        $this->createCoreXmlFile();
+        if ([] !== $this->properties->customProperties) {
+            $this->createCustomXmlFile();
         $this->createCoreXmlFile();
         return $this;
+    }
     private function createAppXmlFile(): self
+    {
         $appXmlFileContents = <<<EOD
             <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
             <Properties xmlns="http://schemas.openxmlformats.org/officeDocument/2006/extended-properties">
-                <Application>{$this->creator}</Application>
+                <Application>{$this->properties->application}</Application>
                 <TotalTime>0</TotalTime>
             </Properties>
             EOD;
+    {
         $createdDate = (new DateTimeImmutable())->format(DateTimeImmutable::W3C);
         $coreXmlFileContents = <<<EOD
             <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
             <cp:coreProperties xmlns:cp="http://schemas.openxmlformats.org/package/2006/metadata/core-properties" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:dcmitype="http://purl.org/dc/dcmitype/" xmlns:dcterms="http://purl.org/dc/terms/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+                <dc:title>{$this->properties->title}</dc:title>
+                <dc:subject>{$this->properties->subject}</dc:subject>
+                <dc:creator>{$this->properties->creator}</dc:creator>
+                <cp:lastModifiedBy>{$this->properties->lastModifiedBy}</cp:lastModifiedBy>
+                <cp:keywords>{$this->properties->keywords}</cp:keywords>
+                <dc:description>{$this->properties->description}</dc:description>
+                <cp:category>{$this->properties->category}</cp:category>
+                <dc:language>{$this->properties->language}</dc:language>
                 <dcterms:created xsi:type="dcterms:W3CDTF">{$createdDate}</dcterms:created>
                 <dcterms:modified xsi:type="dcterms:W3CDTF">{$createdDate}</dcterms:modified>
                 <cp:revision>0</cp:revision>
             </cp:coreProperties>
             EOD;
         return $this;
+    }
+    /**
+     * Creates the "custom.xml" file under the "docProps" folder.
+     *
+     * @throws IOException If unable to create the file
+     */
+    private function createCustomXmlFile(): self
+    {
+        /** The pid must increment for each property, starting with 2 */
+        $pid = 2;
+        $propertiesXmlContents = '';
+        foreach ($this->properties->customProperties as $name => $value) {
+            $propertiesXmlContents .= <<<EOD
+                <property fmtid="{D5CDD505-2E9C-101B-9397-08002B2CF9AE}" pid="{$pid}" name="{$name}"><vt:lpwstr>{$value}</vt:lpwstr></property>
+                EOD;
+            ++$pid;
+        }
+        $customXmlFileContents = <<<EOD
+            <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+            <Properties xmlns="http://schemas.openxmlformats.org/officeDocument/2006/custom-properties" xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes">{$propertiesXmlContents}</Properties>
+            EOD;
+        $this->createFileWithContents($this->docPropsFolder, self::CUSTOM_XML_FILE_NAME, $customXmlFileContents);
+        return $this;
+    }
     /**
      * Creates the "xl" folder under the root folder as well as its subfolders.
+     *
      * @throws IOException If unable to create at least one of the folders

Proyectos de Subversion Moodle

(root)/lib/openspout/src/Writer/XLSX/Helper/FileSystemHelper.php – Rev 1 → 1441