WorkbookManagerAbstract::getWorksheetFilePath()

Passed

Pull Request — develop_3.0 (#491)

by Adrien

created 2017-11-05 13:00 UTC

↳ Parent: WorkbookManagerAbstract

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	1
ccs	0
cts	0
cp	0
c	0
b	0
f	0
nc	1

<?php

namespace Box\Spout\Writer\Common\Manager;

use Box\Spout\Common\Exception\IOException;
use Box\Spout\Common\Manager\OptionsManagerInterface;
use Box\Spout\Writer\Common\Creator\InternalEntityFactory;
use Box\Spout\Writer\Common\Creator\ManagerFactoryInterface;
use Box\Spout\Writer\Common\Entity\Options;
use Box\Spout\Writer\Common\Entity\Row;
use Box\Spout\Writer\Common\Entity\Sheet;
use Box\Spout\Writer\Common\Entity\Workbook;
use Box\Spout\Writer\Common\Entity\Worksheet;
use Box\Spout\Writer\Common\Helper\FileSystemWithRootFolderHelperInterface;
use Box\Spout\Writer\Common\Manager\Style\StyleManagerInterface;
use Box\Spout\Writer\Common\Manager\Style\StyleMerger;
use Box\Spout\Writer\Exception\SheetNotFoundException;
use Box\Spout\Writer\Exception\WriterException;

/**
 * Class WorkbookManagerAbstract
 * Abstract workbook manager, providing the generic interfaces to work with workbook.
 */
abstract class WorkbookManagerAbstract implements WorkbookManagerInterface
{
    /** @var Workbook The workbook to manage */
    protected $workbook;

    /** @var OptionsManagerInterface */
    protected $optionsManager;

    /** @var WorksheetManagerInterface */
    protected $worksheetManager;

    /** @var StyleManagerInterface Manages styles */
    protected $styleManager;

    /** @var StyleMerger Helper to merge styles */
    protected $styleMerger;

    /** @var FileSystemWithRootFolderHelperInterface Helper to perform file system operations */
    protected $fileSystemHelper;

    /** @var InternalEntityFactory Factory to create entities */
    protected $entityFactory;

    /** @var ManagerFactoryInterface $managerFactory Factory to create managers */
    protected $managerFactory;

    /** @var Worksheet The worksheet where data will be written to */
    protected $currentWorksheet;

    /**
     * @param Workbook $workbook
     * @param OptionsManagerInterface $optionsManager
     * @param WorksheetManagerInterface $worksheetManager
     * @param StyleManagerInterface $styleManager
     * @param StyleMerger $styleMerger
     * @param FileSystemWithRootFolderHelperInterface $fileSystemHelper
     * @param InternalEntityFactory $entityFactory
     * @param ManagerFactoryInterface $managerFactory
     */
    public function __construct(
        Workbook $workbook,
        OptionsManagerInterface $optionsManager,
        WorksheetManagerInterface $worksheetManager,
        StyleManagerInterface $styleManager,
        StyleMerger $styleMerger,
        FileSystemWithRootFolderHelperInterface $fileSystemHelper,
        InternalEntityFactory $entityFactory,
        ManagerFactoryInterface $managerFactory
    ) {
        $this->workbook = $workbook;
        $this->optionsManager = $optionsManager;
        $this->worksheetManager = $worksheetManager;
        $this->styleManager = $styleManager;
        $this->styleMerger = $styleMerger;
        $this->fileSystemHelper = $fileSystemHelper;
        $this->entityFactory = $entityFactory;
        $this->managerFactory = $managerFactory;
    }

    /**
     * @return int Maximum number of rows/columns a sheet can contain
     */
    abstract protected function getMaxRowsPerWorksheet();

    /**
     * @param Sheet $sheet
     * @return string The file path where the data for the given sheet will be stored
     */
    abstract protected function getWorksheetFilePath(Sheet $sheet);

    /**
     * @return Workbook
     */
    public function getWorkbook()
    {
        return $this->workbook;
    }

    /**
     * Creates a new sheet in the workbook and make it the current sheet.
     * The writing will resume where it stopped (i.e. data won't be truncated).
     *
     * @throws IOException If unable to open the sheet for writing
     * @return Worksheet The created sheet
     */
    public function addNewSheetAndMakeItCurrent()
    {
        $worksheet = $this->addNewSheet();
        $this->setCurrentWorksheet($worksheet);

        return $worksheet;
    }

    /**
     * Creates a new sheet in the workbook. The current sheet remains unchanged.
     *
     * @throws \Box\Spout\Common\Exception\IOException If unable to open the sheet for writing
     * @return Worksheet The created sheet
     */
    private function addNewSheet()
    {
        $worksheets = $this->getWorksheets();

        $newSheetIndex = count($worksheets);
        $sheetManager = $this->managerFactory->createSheetManager();
        $sheet = $this->entityFactory->createSheet($newSheetIndex, $this->workbook->getInternalId(), $sheetManager);

        $worksheetFilePath = $this->getWorksheetFilePath($sheet);
        $worksheet = $this->entityFactory->createWorksheet($worksheetFilePath, $sheet);

        $this->worksheetManager->startSheet($worksheet);

        $worksheets[] = $worksheet;
        $this->workbook->setWorksheets($worksheets);

        return $worksheet;
    }

    /**
     * @return Worksheet[] All the workbook's sheets
     */
    public function getWorksheets()
    {
        return $this->workbook->getWorksheets();
    }

    /**
     * Returns the current sheet
     *
     * @return Worksheet The current sheet
     */
    public function getCurrentWorksheet()
    {
        return $this->currentWorksheet;
    }

    /**
     * Sets the given sheet as the current one. New data will be written to this sheet.
     * The writing will resume where it stopped (i.e. data won't be truncated).
     *
     * @param Sheet $sheet The "external" sheet to set as current
     * @throws SheetNotFoundException If the given sheet does not exist in the workbook
     * @return void
     */
    public function setCurrentSheet(Sheet $sheet)
    {
        $worksheet = $this->getWorksheetFromExternalSheet($sheet);
        if ($worksheet !== null) {
            $this->currentWorksheet = $worksheet;
        } else {
            throw new SheetNotFoundException('The given sheet does not exist in the workbook.');
        }
    }

    /**
     * @param Worksheet $worksheet
     * @return void
     */
    private function setCurrentWorksheet($worksheet)
    {
        $this->currentWorksheet = $worksheet;
    }

    /**
     * Returns the worksheet associated to the given external sheet.
     *
     * @param Sheet $sheet
     * @return Worksheet|null The worksheet associated to the given external sheet or null if not found.
     */
    private function getWorksheetFromExternalSheet($sheet)
    {
        $worksheetFound = null;

        foreach ($this->getWorksheets() as $worksheet) {
            if ($worksheet->getExternalSheet() === $sheet) {
                $worksheetFound = $worksheet;
                break;
            }
        }

        return $worksheetFound;
    }

    /**
     * Adds a row to the current sheet.
     * If shouldCreateNewSheetsAutomatically option is set to true, it will handle pagination
     * with the creation of new worksheets if one worksheet has reached its maximum capicity.
     *
     * @param Row $row The row to be added
     * @throws IOException If trying to create a new sheet and unable to open the sheet for writing
     * @throws WriterException If unable to write data
     * @return void
     */
    public function addRowToCurrentWorksheet(Row $row)
    {
        $currentWorksheet = $this->getCurrentWorksheet();
        $hasReachedMaxRows = $this->hasCurrentWorksheetReachedMaxRows();

        // if we reached the maximum number of rows for the current sheet...
        if ($hasReachedMaxRows) {
            // ... continue writing in a new sheet if option set
            if ($this->optionsManager->getOption(Options::SHOULD_CREATE_NEW_SHEETS_AUTOMATICALLY)) {
                $currentWorksheet = $this->addNewSheetAndMakeItCurrent();

                $this->addRowToWorksheet($currentWorksheet, $row);
            } else {
                // otherwise, do nothing as the data won't be written anyways
            }
        } else {
            $this->addRowToWorksheet($currentWorksheet, $row);
        }
    }

    /**
     * @return bool Whether the current worksheet has reached the maximum number of rows per sheet.
     */
    private function hasCurrentWorksheetReachedMaxRows()
    {
        $currentWorksheet = $this->getCurrentWorksheet();

        return ($currentWorksheet->getLastWrittenRowIndex() >= $this->getMaxRowsPerWorksheet());
    }

    /**
     * Adds a row to the given sheet.
     *
     * @param Worksheet $worksheet Worksheet to write the row to
     * @param Row $row The row to be added
     * @throws WriterException If unable to write data
     * @return void
     */
    private function addRowToWorksheet(Worksheet $worksheet, Row $row)
    {
        $this->applyDefaultRowStyle($row);
        $this->worksheetManager->addRow($worksheet, $row);

        // update max num columns for the worksheet
        $currentMaxNumColumns = $worksheet->getMaxNumColumns();
        $cellsCount = count($row->getCells());
        $worksheet->setMaxNumColumns(max($currentMaxNumColumns, $cellsCount));
    }

    /**
     * @param Row $row
     */
    private function applyDefaultRowStyle(Row $row)
    {
        $defaultRowStyle = $this->optionsManager->getOption(Options::DEFAULT_ROW_STYLE);

        if ($defaultRowStyle !== null) {
            $mergedStyle = $this->styleMerger->merge($row->getStyle(), $defaultRowStyle);
            $row->setStyle($mergedStyle);
        }
    }

    /**
     * Closes the workbook and all its associated sheets.
     * All the necessary files are written to disk and zipped together to create the final file.
     * All the temporary files are then deleted.
     *
     * @param resource $finalFilePointer Pointer to the spreadsheet that will be created
     * @return void
     */
    public function close($finalFilePointer)
    {
        $this->closeAllWorksheets();
        $this->closeRemainingObjects();
        $this->writeAllFilesToDiskAndZipThem($finalFilePointer);
        $this->cleanupTempFolder();
    }

    /**
     * Closes custom objects that are still opened
     *
     * @return void
     */
    protected function closeRemainingObjects()
    {
        // do nothing by default
    }

    /**
     * Writes all the necessary files to disk and zip them together to create the final file.
     *
     * @param resource $finalFilePointer Pointer to the spreadsheet that will be created
     * @return void
     */
    abstract protected function writeAllFilesToDiskAndZipThem($finalFilePointer);

    /**
     * Closes all workbook's associated sheets.
     *
     * @return void
     */
    private function closeAllWorksheets()
    {
        $worksheets = $this->getWorksheets();

        foreach ($worksheets as $worksheet) {
            $this->worksheetManager->close($worksheet);
        }
    }

    /**
     * Deletes the root folder created in the temp folder and all its contents.
     *
     * @return void
     */
    protected function cleanupTempFolder()
    {
        $rootFolder = $this->fileSystemHelper->getRootFolder();
        $this->fileSystemHelper->deleteFolderRecursively($rootFolder);
    }
}


1		<?php
2
3		namespace Box\Spout\Writer\Common\Manager;
4
5		use Box\Spout\Common\Exception\IOException;
6		use Box\Spout\Common\Manager\OptionsManagerInterface;
7		use Box\Spout\Writer\Common\Creator\InternalEntityFactory;
8		use Box\Spout\Writer\Common\Creator\ManagerFactoryInterface;
9		use Box\Spout\Writer\Common\Entity\Options;
10		use Box\Spout\Writer\Common\Entity\Row;
11		use Box\Spout\Writer\Common\Entity\Sheet;
12		use Box\Spout\Writer\Common\Entity\Workbook;
13		use Box\Spout\Writer\Common\Entity\Worksheet;
14		use Box\Spout\Writer\Common\Helper\FileSystemWithRootFolderHelperInterface;
15		use Box\Spout\Writer\Common\Manager\Style\StyleManagerInterface;
16		use Box\Spout\Writer\Common\Manager\Style\StyleMerger;
17		use Box\Spout\Writer\Exception\SheetNotFoundException;
18		use Box\Spout\Writer\Exception\WriterException;
19
20		/**
21		* Class WorkbookManagerAbstract
22		* Abstract workbook manager, providing the generic interfaces to work with workbook.
23		*/
24		abstract class WorkbookManagerAbstract implements WorkbookManagerInterface
25		{
26		/** @var Workbook The workbook to manage */
27		protected $workbook;
28
29		/** @var OptionsManagerInterface */
30		protected $optionsManager;
31
32		/** @var WorksheetManagerInterface */
33		protected $worksheetManager;
34
35		/** @var StyleManagerInterface Manages styles */
36		protected $styleManager;
37
38		/** @var StyleMerger Helper to merge styles */
39		protected $styleMerger;
40
41		/** @var FileSystemWithRootFolderHelperInterface Helper to perform file system operations */
42		protected $fileSystemHelper;
43
44		/** @var InternalEntityFactory Factory to create entities */
45		protected $entityFactory;
46
47		/** @var ManagerFactoryInterface $managerFactory Factory to create managers */
48		protected $managerFactory;
49
50		/** @var Worksheet The worksheet where data will be written to */
51		protected $currentWorksheet;
52
53		/**
54		* @param Workbook $workbook
55		* @param OptionsManagerInterface $optionsManager
56		* @param WorksheetManagerInterface $worksheetManager
57		* @param StyleManagerInterface $styleManager
58		* @param StyleMerger $styleMerger
59		* @param FileSystemWithRootFolderHelperInterface $fileSystemHelper
60		* @param InternalEntityFactory $entityFactory
61		* @param ManagerFactoryInterface $managerFactory
62		*/
63	73	public function __construct(
64		Workbook $workbook,
65		OptionsManagerInterface $optionsManager,
66		WorksheetManagerInterface $worksheetManager,
67		StyleManagerInterface $styleManager,
68		StyleMerger $styleMerger,
69		FileSystemWithRootFolderHelperInterface $fileSystemHelper,
70		InternalEntityFactory $entityFactory,
71		ManagerFactoryInterface $managerFactory
72		) {
73	73	$this->workbook = $workbook;
74	73	$this->optionsManager = $optionsManager;
75	73	$this->worksheetManager = $worksheetManager;
76	73	$this->styleManager = $styleManager;
77	73	$this->styleMerger = $styleMerger;
78	73	$this->fileSystemHelper = $fileSystemHelper;
79	73	$this->entityFactory = $entityFactory;
80	73	$this->managerFactory = $managerFactory;
81	73	}
82
83		/**
84		* @return int Maximum number of rows/columns a sheet can contain
85		*/
86		abstract protected function getMaxRowsPerWorksheet();
87
88		/**
89		* @param Sheet $sheet
90		* @return string The file path where the data for the given sheet will be stored
91		*/
92		abstract protected function getWorksheetFilePath(Sheet $sheet);
93
94		/**
95		* @return Workbook
96		*/
97	65	public function getWorkbook()
98		{
99	65	return $this->workbook;
100		}
101
102		/**
103		* Creates a new sheet in the workbook and make it the current sheet.
104		* The writing will resume where it stopped (i.e. data won't be truncated).
105		*
106		* @throws IOException If unable to open the sheet for writing
107		* @return Worksheet The created sheet
108		*/
109	73	public function addNewSheetAndMakeItCurrent()
110		{
111	73	$worksheet = $this->addNewSheet();
112	73	$this->setCurrentWorksheet($worksheet);
113
114	73	return $worksheet;
115		}
116
117		/**
118		* Creates a new sheet in the workbook. The current sheet remains unchanged.
119		*
120		* @throws \Box\Spout\Common\Exception\IOException If unable to open the sheet for writing
121		* @return Worksheet The created sheet
122		*/
123	73	private function addNewSheet()
124		{
125	73	$worksheets = $this->getWorksheets();
126
127	73	$newSheetIndex = count($worksheets);
128	73	$sheetManager = $this->managerFactory->createSheetManager();
129	73	$sheet = $this->entityFactory->createSheet($newSheetIndex, $this->workbook->getInternalId(), $sheetManager);
130
131	73	$worksheetFilePath = $this->getWorksheetFilePath($sheet);
132	73	$worksheet = $this->entityFactory->createWorksheet($worksheetFilePath, $sheet);
133
134	73	$this->worksheetManager->startSheet($worksheet);
135
136	73	$worksheets[] = $worksheet;
137	73	$this->workbook->setWorksheets($worksheets);
138
139	73	return $worksheet;
140		}
141
142		/**
143		* @return Worksheet[] All the workbook's sheets
144		*/
145	73	public function getWorksheets()
146		{
147	73	return $this->workbook->getWorksheets();
148		}
149
150		/**
151		* Returns the current sheet
152		*
153		* @return Worksheet The current sheet
154		*/
155	65	public function getCurrentWorksheet()
156		{
157	65	return $this->currentWorksheet;
158		}
159
160		/**
161		* Sets the given sheet as the current one. New data will be written to this sheet.
162		* The writing will resume where it stopped (i.e. data won't be truncated).
163		*
164		* @param Sheet $sheet The "external" sheet to set as current
165		* @throws SheetNotFoundException If the given sheet does not exist in the workbook
166		* @return void
167		*/
168	4	public function setCurrentSheet(Sheet $sheet)
169		{
170	4	$worksheet = $this->getWorksheetFromExternalSheet($sheet);
171	4	if ($worksheet !== null) {
172	4	$this->currentWorksheet = $worksheet;
173		} else {
174		throw new SheetNotFoundException('The given sheet does not exist in the workbook.');
175		}
176	4	}
177
178		/**
179		* @param Worksheet $worksheet
180		* @return void
181		*/
182	73	private function setCurrentWorksheet($worksheet)
183		{
184	73	$this->currentWorksheet = $worksheet;
185	73	}
186
187		/**
188		* Returns the worksheet associated to the given external sheet.
189		*
190		* @param Sheet $sheet
191		* @return Worksheet\|null The worksheet associated to the given external sheet or null if not found.
192		*/
193	4	private function getWorksheetFromExternalSheet($sheet)
194		{
195	4	$worksheetFound = null;
196
197	4	foreach ($this->getWorksheets() as $worksheet) {
198	4	if ($worksheet->getExternalSheet() === $sheet) {
199	4	$worksheetFound = $worksheet;
200	4	break;
201		}
202		}
203
204	4	return $worksheetFound;
205		}
206
207		/**
208		* Adds a row to the current sheet.
209		* If shouldCreateNewSheetsAutomatically option is set to true, it will handle pagination
210		* with the creation of new worksheets if one worksheet has reached its maximum capicity.
211		*
212		* @param Row $row The row to be added
213		* @throws IOException If trying to create a new sheet and unable to open the sheet for writing
214		* @throws WriterException If unable to write data
215		* @return void
216		*/
217	59	public function addRowToCurrentWorksheet(Row $row)
218		{
219	59	$currentWorksheet = $this->getCurrentWorksheet();
220	59	$hasReachedMaxRows = $this->hasCurrentWorksheetReachedMaxRows();
221
222		// if we reached the maximum number of rows for the current sheet...
223	59	if ($hasReachedMaxRows) {
224		// ... continue writing in a new sheet if option set
225	4	if ($this->optionsManager->getOption(Options::SHOULD_CREATE_NEW_SHEETS_AUTOMATICALLY)) {
226	2	$currentWorksheet = $this->addNewSheetAndMakeItCurrent();
227
228	2	$this->addRowToWorksheet($currentWorksheet, $row);
229	4	} else {
230		// otherwise, do nothing as the data won't be written anyways
231		}
232		} else {
233	59	$this->addRowToWorksheet($currentWorksheet, $row);
234		}
235	57	}
236
237		/**
238		* @return bool Whether the current worksheet has reached the maximum number of rows per sheet.
239		*/
240	59	private function hasCurrentWorksheetReachedMaxRows()
241		{
242	59	$currentWorksheet = $this->getCurrentWorksheet();
243
244	59	return ($currentWorksheet->getLastWrittenRowIndex() >= $this->getMaxRowsPerWorksheet());
245		}
246
247		/**
248		* Adds a row to the given sheet.
249		*
250		* @param Worksheet $worksheet Worksheet to write the row to
251		* @param Row $row The row to be added
252		* @throws WriterException If unable to write data
253		* @return void
254		*/
255	59	private function addRowToWorksheet(Worksheet $worksheet, Row $row)
256		{
257	59	$this->applyDefaultRowStyle($row);
258	59	$this->worksheetManager->addRow($worksheet, $row);
259
260		// update max num columns for the worksheet
261	57	$currentMaxNumColumns = $worksheet->getMaxNumColumns();
262	57	$cellsCount = count($row->getCells());
263	57	$worksheet->setMaxNumColumns(max($currentMaxNumColumns, $cellsCount));
264	57	}
265
266		/**
267		* @param Row $row
268		*/
269	59	private function applyDefaultRowStyle(Row $row)
270		{
271	59	$defaultRowStyle = $this->optionsManager->getOption(Options::DEFAULT_ROW_STYLE);
272
273	59	if ($defaultRowStyle !== null) {
274	59	$mergedStyle = $this->styleMerger->merge($row->getStyle(), $defaultRowStyle);
275	59	$row->setStyle($mergedStyle);
276		}
277	59	}
278
279		/**
280		* Closes the workbook and all its associated sheets.
281		* All the necessary files are written to disk and zipped together to create the final file.
282		* All the temporary files are then deleted.
283		*
284		* @param resource $finalFilePointer Pointer to the spreadsheet that will be created
285		* @return void
286		*/
287	66	public function close($finalFilePointer)
288		{
289	66	$this->closeAllWorksheets();
290	66	$this->closeRemainingObjects();
291	66	$this->writeAllFilesToDiskAndZipThem($finalFilePointer);
292	66	$this->cleanupTempFolder();
293	66	}
294
295		/**
296		* Closes custom objects that are still opened
297		*
298		* @return void
299		*/
300	32	protected function closeRemainingObjects()
301		{
302		// do nothing by default
303	32	}
304
305		/**
306		* Writes all the necessary files to disk and zip them together to create the final file.
307		*
308		* @param resource $finalFilePointer Pointer to the spreadsheet that will be created
309		* @return void
310		*/
311		abstract protected function writeAllFilesToDiskAndZipThem($finalFilePointer);
312
313		/**
314		* Closes all workbook's associated sheets.
315		*
316		* @return void
317		*/
318	66	private function closeAllWorksheets()
319		{
320	66	$worksheets = $this->getWorksheets();
321
322	66	foreach ($worksheets as $worksheet) {
323	66	$this->worksheetManager->close($worksheet);
324		}
325	66	}
326
327		/**
328		* Deletes the root folder created in the temp folder and all its contents.
329		*
330		* @return void
331		*/
332	66	protected function cleanupTempFolder()
333		{
334	66	$rootFolder = $this->fileSystemHelper->getRootFolder();
335	66	$this->fileSystemHelper->deleteFolderRecursively($rootFolder);
336	66	}
337		}
338

box / spout

Pull Request — develop_3.0 (#491)

WorkbookManagerAbstract::getWorksheetFilePath()

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like