From f46e3a191681701dd25aa116a12708dbf6fd043d Mon Sep 17 00:00:00 2001 From: Adrien Crivelli Date: Wed, 17 Nov 2021 23:38:44 +0900 Subject: [PATCH] Use native typing for objects that were already documented as such --- phpstan-baseline.neon | 62 +--------------- .../Calculation/Calculation.php | 2 +- src/PhpSpreadsheet/Cell/Cell.php | 10 +-- src/PhpSpreadsheet/Chart/Chart.php | 2 - src/PhpSpreadsheet/Collection/Cells.php | 2 +- src/PhpSpreadsheet/Reader/Html.php | 3 +- src/PhpSpreadsheet/Reader/Xlsx.php | 4 +- .../Reader/Xlsx/ColumnAndRowAttributes.php | 6 +- src/PhpSpreadsheet/RichText/RichText.php | 2 - .../Escher/DgContainer/SpgrContainer.php | 10 +-- .../Escher/DggContainer/BstoreContainer.php | 6 +- .../DggContainer/BstoreContainer/BSE.php | 12 ++-- .../DggContainer/BstoreContainer/BSE/Blip.php | 12 ++-- src/PhpSpreadsheet/Spreadsheet.php | 4 +- src/PhpSpreadsheet/Style/Conditional.php | 2 - src/PhpSpreadsheet/Worksheet/AutoFilter.php | 6 +- .../Worksheet/AutoFilter/Column.php | 2 - src/PhpSpreadsheet/Worksheet/BaseDrawing.php | 7 +- src/PhpSpreadsheet/Worksheet/Column.php | 1 - src/PhpSpreadsheet/Worksheet/Drawing.php | 4 +- .../Worksheet/Drawing/Shadow.php | 2 - .../Worksheet/MemoryDrawing.php | 4 +- src/PhpSpreadsheet/Worksheet/Row.php | 1 - src/PhpSpreadsheet/Worksheet/Worksheet.php | 1 - src/PhpSpreadsheet/Writer/Xls.php | 2 - src/PhpSpreadsheet/Writer/Xls/Workbook.php | 10 +-- src/PhpSpreadsheet/Writer/Xls/Worksheet.php | 10 +-- src/PhpSpreadsheet/Writer/Xlsx/Chart.php | 71 ++++--------------- src/PhpSpreadsheet/Writer/Xlsx/Comments.php | 2 - .../Writer/Xlsx/ContentTypes.php | 2 - src/PhpSpreadsheet/Writer/Xlsx/Drawing.php | 4 -- src/PhpSpreadsheet/Writer/Xlsx/Rels.php | 16 ++--- .../Writer/Xlsx/StringTable.php | 3 - src/PhpSpreadsheet/Writer/Xlsx/Style.php | 26 ------- src/PhpSpreadsheet/Writer/Xlsx/Workbook.php | 12 ---- src/PhpSpreadsheet/Writer/Xlsx/Worksheet.php | 52 -------------- 36 files changed, 54 insertions(+), 323 deletions(-) diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon index bcdba204..44e63613 100644 --- a/phpstan-baseline.neon +++ b/phpstan-baseline.neon @@ -7090,16 +7090,6 @@ parameters: count: 1 path: src/PhpSpreadsheet/Writer/Xls/Workbook.php - - - message: "#^Property PhpOffice\\\\PhpSpreadsheet\\\\Writer\\\\Xls\\\\Workbook\\:\\:\\$escher \\(PhpOffice\\\\PhpSpreadsheet\\\\Shared\\\\Escher\\) does not accept PhpOffice\\\\PhpSpreadsheet\\\\Shared\\\\Escher\\|null\\.$#" - count: 1 - path: src/PhpSpreadsheet/Writer/Xls/Workbook.php - - - - message: "#^Property PhpOffice\\\\PhpSpreadsheet\\\\Writer\\\\Xls\\\\Workbook\\:\\:\\$escher \\(PhpOffice\\\\PhpSpreadsheet\\\\Shared\\\\Escher\\) in isset\\(\\) is not nullable\\.$#" - count: 1 - path: src/PhpSpreadsheet/Writer/Xls/Workbook.php - - message: "#^Cannot access offset 'comp' on array\\|false\\.$#" count: 1 @@ -7255,16 +7245,6 @@ parameters: count: 1 path: src/PhpSpreadsheet/Writer/Xls/Worksheet.php - - - message: "#^Property PhpOffice\\\\PhpSpreadsheet\\\\Writer\\\\Xls\\\\Worksheet\\:\\:\\$escher \\(PhpOffice\\\\PhpSpreadsheet\\\\Shared\\\\Escher\\) does not accept PhpOffice\\\\PhpSpreadsheet\\\\Shared\\\\Escher\\|null\\.$#" - count: 1 - path: src/PhpSpreadsheet/Writer/Xls/Worksheet.php - - - - message: "#^Property PhpOffice\\\\PhpSpreadsheet\\\\Writer\\\\Xls\\\\Worksheet\\:\\:\\$escher \\(PhpOffice\\\\PhpSpreadsheet\\\\Shared\\\\Escher\\) in isset\\(\\) is not nullable\\.$#" - count: 1 - path: src/PhpSpreadsheet/Writer/Xls/Worksheet.php - - message: "#^Property PhpOffice\\\\PhpSpreadsheet\\\\Writer\\\\Xls\\\\Worksheet\\:\\:\\$outlineBelow is never read, only written\\.$#" count: 1 @@ -7325,11 +7305,6 @@ parameters: count: 1 path: src/PhpSpreadsheet/Writer/Xlsx.php - - - message: "#^Argument of an invalid type array\\|string supplied for foreach, only iterables are supported\\.$#" - count: 1 - path: src/PhpSpreadsheet/Writer/Xlsx/Chart.php - - message: "#^Cannot access offset int on mixed\\.$#" count: 2 @@ -7351,12 +7326,7 @@ parameters: path: src/PhpSpreadsheet/Writer/Xlsx/Chart.php - - message: "#^Method PhpOffice\\\\PhpSpreadsheet\\\\Writer\\\\Xlsx\\\\Chart\\:\\:getChartType\\(\\) never returns string so it can be removed from the return type\\.$#" - count: 1 - path: src/PhpSpreadsheet/Writer/Xlsx/Chart.php - - - - message: "#^Parameter \\#1 \\$plotSeriesValues of method PhpOffice\\\\PhpSpreadsheet\\\\Writer\\\\Xlsx\\\\Chart\\:\\:writeBubbles\\(\\) expects PhpOffice\\\\PhpSpreadsheet\\\\Chart\\\\DataSeriesValues, PhpOffice\\\\PhpSpreadsheet\\\\Chart\\\\DataSeriesValues\\|false given\\.$#" + message: "#^Parameter \\#1 \\$plotSeriesValues of method PhpOffice\\\\PhpSpreadsheet\\\\Writer\\\\Xlsx\\\\Chart\\:\\:writeBubbles\\(\\) expects PhpOffice\\\\PhpSpreadsheet\\\\Chart\\\\DataSeriesValues|null, PhpOffice\\\\PhpSpreadsheet\\\\Chart\\\\DataSeriesValues\\|false given\\.$#" count: 1 path: src/PhpSpreadsheet/Writer/Xlsx/Chart.php @@ -7400,16 +7370,6 @@ parameters: count: 2 path: src/PhpSpreadsheet/Writer/Xlsx/Chart.php - - - message: "#^Parameter \\#2 \\$xAxisLabel of method PhpOffice\\\\PhpSpreadsheet\\\\Writer\\\\Xlsx\\\\Chart\\:\\:writeCategoryAxis\\(\\) expects PhpOffice\\\\PhpSpreadsheet\\\\Chart\\\\Title, PhpOffice\\\\PhpSpreadsheet\\\\Chart\\\\Title\\|null given\\.$#" - count: 1 - path: src/PhpSpreadsheet/Writer/Xlsx/Chart.php - - - - message: "#^Parameter \\#2 \\$yAxisLabel of method PhpOffice\\\\PhpSpreadsheet\\\\Writer\\\\Xlsx\\\\Chart\\:\\:writeValueAxis\\(\\) expects PhpOffice\\\\PhpSpreadsheet\\\\Chart\\\\Title, PhpOffice\\\\PhpSpreadsheet\\\\Chart\\\\Title\\|null given\\.$#" - count: 2 - path: src/PhpSpreadsheet/Writer/Xlsx/Chart.php - - message: "#^Parameter \\#3 \\$id1 of method PhpOffice\\\\PhpSpreadsheet\\\\Writer\\\\Xlsx\\\\Chart\\:\\:writeCategoryAxis\\(\\) expects string, int\\|string given\\.$#" count: 1 @@ -7465,16 +7425,6 @@ parameters: count: 1 path: src/PhpSpreadsheet/Writer/Xlsx/Chart.php - - - message: "#^Strict comparison using \\=\\=\\= between PhpOffice\\\\PhpSpreadsheet\\\\Chart\\\\DataSeries and null will always evaluate to false\\.$#" - count: 1 - path: src/PhpSpreadsheet/Writer/Xlsx/Chart.php - - - - message: "#^Strict comparison using \\=\\=\\= between PhpOffice\\\\PhpSpreadsheet\\\\Chart\\\\DataSeriesValues and null will always evaluate to false\\.$#" - count: 3 - path: src/PhpSpreadsheet/Writer/Xlsx/Chart.php - - message: "#^Strict comparison using \\=\\=\\= between PhpOffice\\\\PhpSpreadsheet\\\\Chart\\\\PlotArea and null will always evaluate to false\\.$#" count: 1 @@ -7545,16 +7495,6 @@ parameters: count: 1 path: src/PhpSpreadsheet/Writer/Xlsx/Drawing.php - - - message: "#^Method PhpOffice\\\\PhpSpreadsheet\\\\Writer\\\\Xlsx\\\\Rels\\:\\:writeDrawingHyperLink\\(\\) has parameter \\$i with no type specified\\.$#" - count: 1 - path: src/PhpSpreadsheet/Writer/Xlsx/Rels.php - - - - message: "#^Method PhpOffice\\\\PhpSpreadsheet\\\\Writer\\\\Xlsx\\\\Rels\\:\\:writeDrawingHyperLink\\(\\) has parameter \\$objWriter with no type specified\\.$#" - count: 1 - path: src/PhpSpreadsheet/Writer/Xlsx/Rels.php - - message: "#^Method PhpOffice\\\\PhpSpreadsheet\\\\Writer\\\\Xlsx\\\\Rels\\:\\:writeUnparsedRelationship\\(\\) has parameter \\$relationship with no type specified\\.$#" count: 1 diff --git a/src/PhpSpreadsheet/Calculation/Calculation.php b/src/PhpSpreadsheet/Calculation/Calculation.php index 8ff5abef..b473b27a 100644 --- a/src/PhpSpreadsheet/Calculation/Calculation.php +++ b/src/PhpSpreadsheet/Calculation/Calculation.php @@ -4230,7 +4230,7 @@ class Calculation if (ctype_digit($val) && $val <= 1048576) { // Row range $stackItemType = 'Row Reference'; - /** @var string */ + /** @var int $valx */ $valx = $val; $endRowColRef = ($refSheet !== null) ? $refSheet->getHighestDataColumn($valx) : 'XFD'; // Max 16,384 columns for Excel2007 $val = "{$rangeWS2}{$endRowColRef}{$val}"; diff --git a/src/PhpSpreadsheet/Cell/Cell.php b/src/PhpSpreadsheet/Cell/Cell.php index 13fe0d8e..5a9def37 100644 --- a/src/PhpSpreadsheet/Cell/Cell.php +++ b/src/PhpSpreadsheet/Cell/Cell.php @@ -70,7 +70,7 @@ class Cell * * @return $this */ - public function updateInCollection() + public function updateInCollection(): self { $this->parent->update($this); @@ -397,12 +397,8 @@ class Cell /** * Set Data validation rules. - * - * @param DataValidation $dataValidation - * - * @return Cell */ - public function setDataValidation(?DataValidation $dataValidation = null) + public function setDataValidation(?DataValidation $dataValidation = null): self { if (!isset($this->parent)) { throw new Exception('Cannot set data validation for cell that is not bound to a worksheet'); @@ -456,8 +452,6 @@ class Cell /** * Set Hyperlink. * - * @param Hyperlink $hyperlink - * * @return Cell */ public function setHyperlink(?Hyperlink $hyperlink = null) diff --git a/src/PhpSpreadsheet/Chart/Chart.php b/src/PhpSpreadsheet/Chart/Chart.php index 106e44c6..bed89464 100644 --- a/src/PhpSpreadsheet/Chart/Chart.php +++ b/src/PhpSpreadsheet/Chart/Chart.php @@ -186,8 +186,6 @@ class Chart /** * Set Worksheet. * - * @param Worksheet $worksheet - * * @return $this */ public function setWorksheet(?Worksheet $worksheet = null) diff --git a/src/PhpSpreadsheet/Collection/Cells.php b/src/PhpSpreadsheet/Collection/Cells.php index 10369e14..e3d81cb4 100644 --- a/src/PhpSpreadsheet/Collection/Cells.php +++ b/src/PhpSpreadsheet/Collection/Cells.php @@ -325,7 +325,7 @@ class Cells // Change prefix $newCollection->cachePrefix = $newCollection->getUniqueID(); foreach ($oldValues as $oldKey => $value) { - /** @var string */ + /** @var string $newKey */ $newKey = str_replace($oldCachePrefix, $newCollection->cachePrefix, $oldKey); $newValues[$newKey] = clone $value; } diff --git a/src/PhpSpreadsheet/Reader/Html.php b/src/PhpSpreadsheet/Reader/Html.php index cd28cbb6..c37f1c1a 100644 --- a/src/PhpSpreadsheet/Reader/Html.php +++ b/src/PhpSpreadsheet/Reader/Html.php @@ -757,12 +757,11 @@ class Html extends BaseReader * TODO : * - Implement to other propertie, such as border * - * @param Worksheet $sheet * @param int $row * @param string $column * @param array $attributeArray */ - private function applyInlineStyle(&$sheet, $row, $column, $attributeArray): void + private function applyInlineStyle(Worksheet &$sheet, $row, $column, $attributeArray): void { if (!isset($attributeArray['style'])) { return; diff --git a/src/PhpSpreadsheet/Reader/Xlsx.php b/src/PhpSpreadsheet/Reader/Xlsx.php index 59403c64..c8b9126c 100644 --- a/src/PhpSpreadsheet/Reader/Xlsx.php +++ b/src/PhpSpreadsheet/Reader/Xlsx.php @@ -1843,11 +1843,9 @@ class Xlsx extends BaseReader } /** - * @param \PhpOffice\PhpSpreadsheet\Worksheet\Drawing $objDrawing - * @param SimpleXMLElement $cellAnchor * @param array $hyperlinks */ - private function readHyperLinkDrawing($objDrawing, $cellAnchor, $hyperlinks): void + private function readHyperLinkDrawing(\PhpOffice\PhpSpreadsheet\Worksheet\Drawing $objDrawing, SimpleXMLElement $cellAnchor, $hyperlinks): void { $hlinkClick = $cellAnchor->pic->nvPicPr->cNvPr->children(Namespaces::DRAWINGML)->hlinkClick; diff --git a/src/PhpSpreadsheet/Reader/Xlsx/ColumnAndRowAttributes.php b/src/PhpSpreadsheet/Reader/Xlsx/ColumnAndRowAttributes.php index 2f7619f7..2a1e2afd 100644 --- a/src/PhpSpreadsheet/Reader/Xlsx/ColumnAndRowAttributes.php +++ b/src/PhpSpreadsheet/Reader/Xlsx/ColumnAndRowAttributes.php @@ -72,11 +72,7 @@ class ColumnAndRowAttributes extends BaseParserClass } } - /** - * @param IReadFilter $readFilter - * @param bool $readDataOnly - */ - public function load(?IReadFilter $readFilter = null, $readDataOnly = false): void + public function load(?IReadFilter $readFilter = null, bool $readDataOnly = false): void { if ($this->worksheetXml === null) { return; diff --git a/src/PhpSpreadsheet/RichText/RichText.php b/src/PhpSpreadsheet/RichText/RichText.php index c1c42134..3a6e1f8e 100644 --- a/src/PhpSpreadsheet/RichText/RichText.php +++ b/src/PhpSpreadsheet/RichText/RichText.php @@ -17,8 +17,6 @@ class RichText implements IComparable /** * Create a new RichText instance. - * - * @param Cell $cell */ public function __construct(?Cell $cell = null) { diff --git a/src/PhpSpreadsheet/Shared/Escher/DgContainer/SpgrContainer.php b/src/PhpSpreadsheet/Shared/Escher/DgContainer/SpgrContainer.php index 1da87726..6bdc8f7d 100644 --- a/src/PhpSpreadsheet/Shared/Escher/DgContainer/SpgrContainer.php +++ b/src/PhpSpreadsheet/Shared/Escher/DgContainer/SpgrContainer.php @@ -7,7 +7,7 @@ class SpgrContainer /** * Parent Shape Group Container. * - * @var \PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer + * @var null|SpgrContainer */ private $parent; @@ -20,20 +20,16 @@ class SpgrContainer /** * Set parent Shape Group Container. - * - * @param \PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer $parent */ - public function setParent($parent): void + public function setParent(?self $parent): void { $this->parent = $parent; } /** * Get the parent Shape Group Container if any. - * - * @return null|\PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer */ - public function getParent() + public function getParent(): ?self { return $this->parent; } diff --git a/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer.php b/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer.php index b07786ff..7203b66b 100644 --- a/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer.php +++ b/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer.php @@ -7,16 +7,14 @@ class BstoreContainer /** * BLIP Store Entries. Each of them holds one BLIP (Big Large Image or Picture). * - * @var array + * @var BstoreContainer\BSE[] */ private $BSECollection = []; /** * Add a BLIP Store Entry. - * - * @param BstoreContainer\BSE $BSE */ - public function addBSE($BSE): void + public function addBSE(BstoreContainer\BSE $BSE): void { $this->BSECollection[] = $BSE; $BSE->setParent($this); diff --git a/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE.php b/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE.php index e8851465..d24af3f7 100644 --- a/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE.php +++ b/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE.php @@ -2,6 +2,8 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer; +use PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer; + class BSE { const BLIPTYPE_ERROR = 0x00; @@ -18,7 +20,7 @@ class BSE /** * The parent BLIP Store Entry Container. * - * @var \PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer + * @var BstoreContainer */ private $parent; @@ -38,10 +40,8 @@ class BSE /** * Set parent BLIP Store Entry Container. - * - * @param \PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer $parent */ - public function setParent($parent): void + public function setParent(BstoreContainer $parent): void { $this->parent = $parent; } @@ -58,10 +58,8 @@ class BSE /** * Set the BLIP. - * - * @param BSE\Blip $blip */ - public function setBlip($blip): void + public function setBlip(BSE\Blip $blip): void { $this->blip = $blip; $blip->setParent($this); diff --git a/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE/Blip.php b/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE/Blip.php index 500d7eaf..03b261f8 100644 --- a/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE/Blip.php +++ b/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE/Blip.php @@ -2,12 +2,14 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\BSE; +use PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\BSE; + class Blip { /** * The parent BSE. * - * @var \PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\BSE + * @var BSE */ private $parent; @@ -40,20 +42,16 @@ class Blip /** * Set parent BSE. - * - * @param \PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\BSE $parent */ - public function setParent($parent): void + public function setParent(BSE $parent): void { $this->parent = $parent; } /** * Get parent BSE. - * - * @return \PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\BSE $parent */ - public function getParent() + public function getParent(): BSE { return $this->parent; } diff --git a/src/PhpSpreadsheet/Spreadsheet.php b/src/PhpSpreadsheet/Spreadsheet.php index 78efc789..9990a68d 100644 --- a/src/PhpSpreadsheet/Spreadsheet.php +++ b/src/PhpSpreadsheet/Spreadsheet.php @@ -1174,11 +1174,9 @@ class Spreadsheet /** * Check if style exists in style collection. * - * @param Style $cellStyleIndex - * * @return bool */ - public function cellXfExists($cellStyleIndex) + public function cellXfExists(Style $cellStyleIndex) { return in_array($cellStyleIndex, $this->cellXfCollection, true); } diff --git a/src/PhpSpreadsheet/Style/Conditional.php b/src/PhpSpreadsheet/Style/Conditional.php index 3f84a4c9..e148ee82 100644 --- a/src/PhpSpreadsheet/Style/Conditional.php +++ b/src/PhpSpreadsheet/Style/Conditional.php @@ -249,8 +249,6 @@ class Conditional implements IComparable /** * Set Style. * - * @param Style $style - * * @return $this */ public function setStyle(?Style $style = null) diff --git a/src/PhpSpreadsheet/Worksheet/AutoFilter.php b/src/PhpSpreadsheet/Worksheet/AutoFilter.php index 4fad6062..01dd8374 100644 --- a/src/PhpSpreadsheet/Worksheet/AutoFilter.php +++ b/src/PhpSpreadsheet/Worksheet/AutoFilter.php @@ -39,7 +39,6 @@ class AutoFilter * Create a new AutoFilter. * * @param string $range Cell range (i.e. A1:E10) - * @param Worksheet $worksheet */ public function __construct($range = '', ?Worksheet $worksheet = null) { @@ -60,8 +59,6 @@ class AutoFilter /** * Set AutoFilter Parent Worksheet. * - * @param Worksheet $worksheet - * * @return $this */ public function setParent(?Worksheet $worksheet = null) @@ -708,11 +705,10 @@ class AutoFilter * Convert a dynamic rule daterange to a custom filter range expression for ease of calculation. * * @param string $dynamicRuleType - * @param AutoFilter\Column $filterColumn * * @return mixed[] */ - private function dynamicFilterDateRange($dynamicRuleType, &$filterColumn) + private function dynamicFilterDateRange($dynamicRuleType, AutoFilter\Column &$filterColumn) { $ruleValues = []; $callBack = [__CLASS__, self::DATE_FUNCTIONS[$dynamicRuleType]]; // What if not found? diff --git a/src/PhpSpreadsheet/Worksheet/AutoFilter/Column.php b/src/PhpSpreadsheet/Worksheet/AutoFilter/Column.php index ef5396f3..ef741ee3 100644 --- a/src/PhpSpreadsheet/Worksheet/AutoFilter/Column.php +++ b/src/PhpSpreadsheet/Worksheet/AutoFilter/Column.php @@ -143,8 +143,6 @@ class Column /** * Set this Column's AutoFilter Parent. * - * @param AutoFilter $parent - * * @return $this */ public function setParent(?AutoFilter $parent = null) diff --git a/src/PhpSpreadsheet/Worksheet/BaseDrawing.php b/src/PhpSpreadsheet/Worksheet/BaseDrawing.php index 7da39a51..b8cfb017 100644 --- a/src/PhpSpreadsheet/Worksheet/BaseDrawing.php +++ b/src/PhpSpreadsheet/Worksheet/BaseDrawing.php @@ -200,7 +200,6 @@ class BaseDrawing implements IComparable /** * Set Worksheet. * - * @param Worksheet $worksheet * @param bool $overrideOld If a Worksheet has already been assigned, overwrite it and remove image from old Worksheet? * * @return $this @@ -379,12 +378,12 @@ class BaseDrawing implements IComparable * $objDrawing->setWidthAndHeight(160,120); * * - * @author Vincent@luo MSN:kele_100@hotmail.com - * * @param int $width * @param int $height * * @return $this + * + * @author Vincent@luo MSN:kele_100@hotmail.com */ public function setWidthAndHeight($width, $height) { @@ -467,8 +466,6 @@ class BaseDrawing implements IComparable /** * Set Shadow. * - * @param Drawing\Shadow $shadow - * * @return $this */ public function setShadow(?Drawing\Shadow $shadow = null) diff --git a/src/PhpSpreadsheet/Worksheet/Column.php b/src/PhpSpreadsheet/Worksheet/Column.php index 8abbabe5..b6f30f1f 100644 --- a/src/PhpSpreadsheet/Worksheet/Column.php +++ b/src/PhpSpreadsheet/Worksheet/Column.php @@ -21,7 +21,6 @@ class Column /** * Create a new column. * - * @param Worksheet $parent * @param string $columnIndex */ public function __construct(?Worksheet $parent = null, $columnIndex = 'A') diff --git a/src/PhpSpreadsheet/Worksheet/Drawing.php b/src/PhpSpreadsheet/Worksheet/Drawing.php index 704e7015..bbb5acf6 100644 --- a/src/PhpSpreadsheet/Worksheet/Drawing.php +++ b/src/PhpSpreadsheet/Worksheet/Drawing.php @@ -45,10 +45,8 @@ class Drawing extends BaseDrawing /** * Get indexed filename (using image index). - * - * @return string */ - public function getIndexedFilename() + public function getIndexedFilename(): string { $fileName = $this->getFilename(); $fileName = str_replace(' ', '_', $fileName); diff --git a/src/PhpSpreadsheet/Worksheet/Drawing/Shadow.php b/src/PhpSpreadsheet/Worksheet/Drawing/Shadow.php index 805fc8d3..a461a51b 100644 --- a/src/PhpSpreadsheet/Worksheet/Drawing/Shadow.php +++ b/src/PhpSpreadsheet/Worksheet/Drawing/Shadow.php @@ -218,8 +218,6 @@ class Shadow implements IComparable /** * Set Color. * - * @param Color $color - * * @return $this */ public function setColor(?Color $color = null) diff --git a/src/PhpSpreadsheet/Worksheet/MemoryDrawing.php b/src/PhpSpreadsheet/Worksheet/MemoryDrawing.php index 7789543a..19a3d1e2 100644 --- a/src/PhpSpreadsheet/Worksheet/MemoryDrawing.php +++ b/src/PhpSpreadsheet/Worksheet/MemoryDrawing.php @@ -202,10 +202,8 @@ class MemoryDrawing extends BaseDrawing /** * Get indexed filename (using image index). - * - * @return string */ - public function getIndexedFilename() + public function getIndexedFilename(): string { $extension = strtolower($this->getMimeType()); $extension = explode('/', $extension); diff --git a/src/PhpSpreadsheet/Worksheet/Row.php b/src/PhpSpreadsheet/Worksheet/Row.php index 01053c39..b5933356 100644 --- a/src/PhpSpreadsheet/Worksheet/Row.php +++ b/src/PhpSpreadsheet/Worksheet/Row.php @@ -21,7 +21,6 @@ class Row /** * Create a new row. * - * @param Worksheet $worksheet * @param int $rowIndex */ public function __construct(?Worksheet $worksheet = null, $rowIndex = 1) diff --git a/src/PhpSpreadsheet/Worksheet/Worksheet.php b/src/PhpSpreadsheet/Worksheet/Worksheet.php index 9ef9958f..24da07af 100644 --- a/src/PhpSpreadsheet/Worksheet/Worksheet.php +++ b/src/PhpSpreadsheet/Worksheet/Worksheet.php @@ -341,7 +341,6 @@ class Worksheet implements IComparable /** * Create a new worksheet. * - * @param Spreadsheet $parent * @param string $title */ public function __construct(?Spreadsheet $parent = null, $title = 'Worksheet') diff --git a/src/PhpSpreadsheet/Writer/Xls.php b/src/PhpSpreadsheet/Writer/Xls.php index 3a04a749..d134d690 100644 --- a/src/PhpSpreadsheet/Writer/Xls.php +++ b/src/PhpSpreadsheet/Writer/Xls.php @@ -246,8 +246,6 @@ class Xls extends BaseWriter // sheet index $sheetIndex = $sheet->getParent()->getIndex($sheet); - $escher = null; - // check if there are any shapes for this sheet $filterRange = $sheet->getAutoFilter()->getRange(); if (count($sheet->getDrawingCollection()) == 0 && empty($filterRange)) { diff --git a/src/PhpSpreadsheet/Writer/Xls/Workbook.php b/src/PhpSpreadsheet/Writer/Xls/Workbook.php index ff0a3005..ccffa181 100644 --- a/src/PhpSpreadsheet/Writer/Xls/Workbook.php +++ b/src/PhpSpreadsheet/Writer/Xls/Workbook.php @@ -169,7 +169,7 @@ class Workbook extends BIFFwriter /** * Escher object corresponding to MSODRAWINGGROUP. * - * @var \PhpOffice\PhpSpreadsheet\Shared\Escher + * @var null|\PhpOffice\PhpSpreadsheet\Shared\Escher */ private $escher; @@ -1174,20 +1174,16 @@ class Workbook extends BIFFwriter /** * Get Escher object. - * - * @return \PhpOffice\PhpSpreadsheet\Shared\Escher */ - public function getEscher() + public function getEscher(): ?\PhpOffice\PhpSpreadsheet\Shared\Escher { return $this->escher; } /** * Set Escher object. - * - * @param \PhpOffice\PhpSpreadsheet\Shared\Escher $escher */ - public function setEscher(?\PhpOffice\PhpSpreadsheet\Shared\Escher $escher = null): void + public function setEscher(?\PhpOffice\PhpSpreadsheet\Shared\Escher $escher): void { $this->escher = $escher; } diff --git a/src/PhpSpreadsheet/Writer/Xls/Worksheet.php b/src/PhpSpreadsheet/Writer/Xls/Worksheet.php index d6d4292c..77ec5de9 100644 --- a/src/PhpSpreadsheet/Writer/Xls/Worksheet.php +++ b/src/PhpSpreadsheet/Writer/Xls/Worksheet.php @@ -188,7 +188,7 @@ class Worksheet extends BIFFwriter /** * Escher object corresponding to MSODRAWING. * - * @var \PhpOffice\PhpSpreadsheet\Shared\Escher + * @var null|\PhpOffice\PhpSpreadsheet\Shared\Escher */ private $escher; @@ -2507,20 +2507,16 @@ class Worksheet extends BIFFwriter /** * Get Escher object. - * - * @return \PhpOffice\PhpSpreadsheet\Shared\Escher */ - public function getEscher() + public function getEscher(): ?\PhpOffice\PhpSpreadsheet\Shared\Escher { return $this->escher; } /** * Set Escher object. - * - * @param \PhpOffice\PhpSpreadsheet\Shared\Escher $escher */ - public function setEscher(?\PhpOffice\PhpSpreadsheet\Shared\Escher $escher = null): void + public function setEscher(?\PhpOffice\PhpSpreadsheet\Shared\Escher $escher): void { $this->escher = $escher; } diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Chart.php b/src/PhpSpreadsheet/Writer/Xlsx/Chart.php index 8f55d4c7..db82f8bc 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/Chart.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/Chart.php @@ -103,9 +103,6 @@ class Chart extends WriterPart /** * Write Chart Title. - * - * @param XMLWriter $objWriter XML Writer - * @param Title $title */ private function writeTitle(XMLWriter $objWriter, ?Title $title = null): void { @@ -146,9 +143,6 @@ class Chart extends WriterPart /** * Write Chart Legend. - * - * @param XMLWriter $objWriter XML Writer - * @param Legend $legend */ private function writeLegend(XMLWriter $objWriter, ?Legend $legend = null): void { @@ -195,12 +189,6 @@ class Chart extends WriterPart /** * Write Chart Plot Area. - * - * @param XMLWriter $objWriter XML Writer - * @param Title $xAxisLabel - * @param Title $yAxisLabel - * @param Axis $xAxis - * @param Axis $yAxis */ private function writePlotArea(XMLWriter $objWriter, PlotArea $plotArea, ?Title $xAxisLabel = null, ?Title $yAxisLabel = null, ?Axis $xAxis = null, ?Axis $yAxis = null, ?GridLines $majorGridlines = null, ?GridLines $minorGridlines = null): void { @@ -329,9 +317,6 @@ class Chart extends WriterPart /** * Write Data Labels. - * - * @param XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Chart\Layout $chartLayout Chart layout */ private function writeDataLabels(XMLWriter $objWriter, ?Layout $chartLayout = null): void { @@ -378,13 +363,11 @@ class Chart extends WriterPart /** * Write Category Axis. * - * @param XMLWriter $objWriter XML Writer - * @param Title $xAxisLabel * @param string $id1 * @param string $id2 * @param bool $isMultiLevelSeries */ - private function writeCategoryAxis($objWriter, $xAxisLabel, $id1, $id2, $isMultiLevelSeries, Axis $yAxis): void + private function writeCategoryAxis(XMLWriter $objWriter, ?Title $xAxisLabel, $id1, $id2, $isMultiLevelSeries, Axis $yAxis): void { $objWriter->startElement('c:catAx'); @@ -495,14 +478,12 @@ class Chart extends WriterPart /** * Write Value Axis. * - * @param XMLWriter $objWriter XML Writer - * @param Title $yAxisLabel - * @param string $groupType Chart type + * @param null|string $groupType Chart type * @param string $id1 * @param string $id2 * @param bool $isMultiLevelSeries */ - private function writeValueAxis($objWriter, $yAxisLabel, $groupType, $id1, $id2, $isMultiLevelSeries, Axis $xAxis, GridLines $majorGridlines, GridLines $minorGridlines): void + private function writeValueAxis(XMLWriter $objWriter, ?Title $yAxisLabel, $groupType, $id1, $id2, $isMultiLevelSeries, Axis $xAxis, GridLines $majorGridlines, GridLines $minorGridlines): void { $objWriter->startElement('c:valAx'); @@ -978,11 +959,9 @@ class Chart extends WriterPart /** * Get the data series type(s) for a chart plot series. * - * @param PlotArea $plotArea - * - * @return array|string + * @return string[] */ - private static function getChartType($plotArea) + private static function getChartType(PlotArea $plotArea): array { $groupCount = $plotArea->getPlotGroupCount(); @@ -1005,13 +984,10 @@ class Chart extends WriterPart /** * Method writing plot series values. * - * @param XMLWriter $objWriter XML Writer - * @param int $val value for idx (default: 3) - * @param string $fillColor hex color (default: FF9900) - * - * @return XMLWriter XML Writer + * @param int $val value for idx (default: 3) + * @param string $fillColor hex color (default: FF9900) */ - private function writePlotSeriesValuesElement($objWriter, $val = 3, $fillColor = 'FF9900') + private function writePlotSeriesValuesElement(XMLWriter $objWriter, $val = 3, $fillColor = 'FF9900'): void { $objWriter->startElement('c:dPt'); $objWriter->startElement('c:idx'); @@ -1030,21 +1006,17 @@ class Chart extends WriterPart $objWriter->endElement(); $objWriter->endElement(); $objWriter->endElement(); - - return $objWriter; } /** * Write Plot Group (series of related plots). * - * @param DataSeries $plotGroup * @param string $groupType Type of plot for dataseries - * @param XMLWriter $objWriter XML Writer * @param bool $catIsMultiLevelSeries Is category a multi-series category * @param bool $valIsMultiLevelSeries Is value set a multi-series set * @param string $plotGroupingType Type of grouping for multi-series values */ - private function writePlotGroup($plotGroup, $groupType, $objWriter, &$catIsMultiLevelSeries, &$valIsMultiLevelSeries, &$plotGroupingType): void + private function writePlotGroup(?DataSeries $plotGroup, $groupType, XMLWriter $objWriter, &$catIsMultiLevelSeries, &$valIsMultiLevelSeries, &$plotGroupingType): void { if ($plotGroup === null) { return; @@ -1225,11 +1197,8 @@ class Chart extends WriterPart /** * Write Plot Series Label. - * - * @param DataSeriesValues $plotSeriesLabel - * @param XMLWriter $objWriter XML Writer */ - private function writePlotSeriesLabel($plotSeriesLabel, $objWriter): void + private function writePlotSeriesLabel(?DataSeriesValues $plotSeriesLabel, XMLWriter $objWriter): void { if ($plotSeriesLabel === null) { return; @@ -1259,12 +1228,10 @@ class Chart extends WriterPart /** * Write Plot Series Values. * - * @param DataSeriesValues $plotSeriesValues - * @param XMLWriter $objWriter XML Writer * @param string $groupType Type of plot for dataseries * @param string $dataType Datatype of series values */ - private function writePlotSeriesValues($plotSeriesValues, XMLWriter $objWriter, $groupType, $dataType = 'str'): void + private function writePlotSeriesValues(?DataSeriesValues $plotSeriesValues, XMLWriter $objWriter, $groupType, $dataType = 'str'): void { if ($plotSeriesValues === null) { return; @@ -1350,11 +1317,8 @@ class Chart extends WriterPart /** * Write Bubble Chart Details. - * - * @param DataSeriesValues $plotSeriesValues - * @param XMLWriter $objWriter XML Writer */ - private function writeBubbles($plotSeriesValues, $objWriter): void + private function writeBubbles(?DataSeriesValues $plotSeriesValues, XMLWriter $objWriter): void { if ($plotSeriesValues === null) { return; @@ -1395,9 +1359,6 @@ class Chart extends WriterPart /** * Write Layout. - * - * @param XMLWriter $objWriter XML Writer - * @param Layout $layout */ private function writeLayout(XMLWriter $objWriter, ?Layout $layout = null): void { @@ -1463,10 +1424,8 @@ class Chart extends WriterPart /** * Write Alternate Content block. - * - * @param XMLWriter $objWriter XML Writer */ - private function writeAlternateContent($objWriter): void + private function writeAlternateContent(XMLWriter $objWriter): void { $objWriter->startElement('mc:AlternateContent'); $objWriter->writeAttribute('xmlns:mc', 'http://schemas.openxmlformats.org/markup-compatibility/2006'); @@ -1491,10 +1450,8 @@ class Chart extends WriterPart /** * Write Printer Settings. - * - * @param XMLWriter $objWriter XML Writer */ - private function writePrintSettings($objWriter): void + private function writePrintSettings(XMLWriter $objWriter): void { $objWriter->startElement('c:printSettings'); diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Comments.php b/src/PhpSpreadsheet/Writer/Xlsx/Comments.php index 565f62d2..62e48f8c 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/Comments.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/Comments.php @@ -65,7 +65,6 @@ class Comments extends WriterPart /** * Write comment to XML format. * - * @param XMLWriter $objWriter XML Writer * @param string $cellReference Cell reference * @param Comment $comment Comment * @param array $authors Array of authors @@ -158,7 +157,6 @@ class Comments extends WriterPart /** * Write VML comment to XML format. * - * @param XMLWriter $objWriter XML Writer * @param string $cellReference Cell reference, eg: 'A1' * @param Comment $comment Comment */ diff --git a/src/PhpSpreadsheet/Writer/Xlsx/ContentTypes.php b/src/PhpSpreadsheet/Writer/Xlsx/ContentTypes.php index e8636aa9..bf0eb081 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/ContentTypes.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/ContentTypes.php @@ -201,7 +201,6 @@ class ContentTypes extends WriterPart /** * Write Default content type. * - * @param XMLWriter $objWriter XML Writer * @param string $partName Part name * @param string $contentType Content type */ @@ -221,7 +220,6 @@ class ContentTypes extends WriterPart /** * Write Override content type. * - * @param XMLWriter $objWriter XML Writer * @param string $partName Part name * @param string $contentType Content type */ diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Drawing.php b/src/PhpSpreadsheet/Writer/Xlsx/Drawing.php index 44573bbd..fa77e2d7 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/Drawing.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/Drawing.php @@ -78,7 +78,6 @@ class Drawing extends WriterPart /** * Write drawings to XML format. * - * @param XMLWriter $objWriter XML Writer * @param int $relationId */ public function writeChart(XMLWriter $objWriter, \PhpOffice\PhpSpreadsheet\Chart\Chart $chart, $relationId = -1): void @@ -148,7 +147,6 @@ class Drawing extends WriterPart /** * Write drawings to XML format. * - * @param XMLWriter $objWriter XML Writer * @param int $relationId * @param null|int $hlinkClickId */ @@ -424,9 +422,7 @@ class Drawing extends WriterPart /** * Write VML comment to XML format. * - * @param XMLWriter $objWriter XML Writer * @param string $reference Reference - * @param HeaderFooterDrawing $image Image */ private function writeVMLHeaderFooterImage(XMLWriter $objWriter, $reference, HeaderFooterDrawing $image): void { diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Rels.php b/src/PhpSpreadsheet/Writer/Xlsx/Rels.php index 56e054e9..fce54c30 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/Rels.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/Rels.php @@ -4,6 +4,7 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx; use PhpOffice\PhpSpreadsheet\Shared\XMLWriter; use PhpOffice\PhpSpreadsheet\Spreadsheet; +use PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing; use PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing; use PhpOffice\PhpSpreadsheet\Writer\Exception as WriterException; @@ -317,13 +318,12 @@ class Rels extends WriterPart $i = 1; $iterator = $worksheet->getDrawingCollection()->getIterator(); while ($iterator->valid()) { + $drawing = $iterator->current(); if ( - $iterator->current() instanceof \PhpOffice\PhpSpreadsheet\Worksheet\Drawing - || $iterator->current() instanceof MemoryDrawing + $drawing instanceof \PhpOffice\PhpSpreadsheet\Worksheet\Drawing + || $drawing instanceof MemoryDrawing ) { // Write relationship for image drawing - /** @var \PhpOffice\PhpSpreadsheet\Worksheet\Drawing $drawing */ - $drawing = $iterator->current(); $this->writeRelationship( $objWriter, $i, @@ -399,7 +399,6 @@ class Rels extends WriterPart /** * Write Override content type. * - * @param XMLWriter $objWriter XML Writer * @param int $id Relationship ID. rId will be prepended! * @param string $type Relationship type * @param string $target Relationship target @@ -424,12 +423,7 @@ class Rels extends WriterPart } } - /** - * @param \PhpOffice\PhpSpreadsheet\Worksheet\Drawing $drawing - * - * @return int - */ - private function writeDrawingHyperLink($objWriter, $drawing, $i) + private function writeDrawingHyperLink(XMLWriter $objWriter, BaseDrawing $drawing, int $i): int { if ($drawing->getHyperlink() === null) { return $i; diff --git a/src/PhpSpreadsheet/Writer/Xlsx/StringTable.php b/src/PhpSpreadsheet/Writer/Xlsx/StringTable.php index e1b754a0..f9a2e711 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/StringTable.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/StringTable.php @@ -112,8 +112,6 @@ class StringTable extends WriterPart /** * Write Rich Text. * - * @param XMLWriter $objWriter XML Writer - * @param RichText $richText Rich text * @param string $prefix Optional Namespace prefix */ public function writeRichText(XMLWriter $objWriter, RichText $richText, $prefix = null): void @@ -195,7 +193,6 @@ class StringTable extends WriterPart /** * Write Rich Text. * - * @param XMLWriter $objWriter XML Writer * @param RichText|string $richText text string or Rich text * @param string $prefix Optional Namespace prefix */ diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Style.php b/src/PhpSpreadsheet/Writer/Xlsx/Style.php index c90a1832..bf306a80 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/Style.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/Style.php @@ -145,9 +145,6 @@ class Style extends WriterPart /** * Write Fill. - * - * @param XMLWriter $objWriter XML Writer - * @param Fill $fill Fill style */ private function writeFill(XMLWriter $objWriter, Fill $fill): void { @@ -166,9 +163,6 @@ class Style extends WriterPart /** * Write Gradient Fill. - * - * @param XMLWriter $objWriter XML Writer - * @param Fill $fill Fill style */ private function writeGradientFill(XMLWriter $objWriter, Fill $fill): void { @@ -209,9 +203,6 @@ class Style extends WriterPart /** * Write Pattern Fill. - * - * @param XMLWriter $objWriter XML Writer - * @param Fill $fill Fill style */ private function writePatternFill(XMLWriter $objWriter, Fill $fill): void { @@ -246,9 +237,6 @@ class Style extends WriterPart /** * Write Font. - * - * @param XMLWriter $objWriter XML Writer - * @param Font $font Font style */ private function writeFont(XMLWriter $objWriter, Font $font): void { @@ -325,9 +313,6 @@ class Style extends WriterPart /** * Write Border. - * - * @param XMLWriter $objWriter XML Writer - * @param Borders $borders Borders style */ private function writeBorder(XMLWriter $objWriter, Borders $borders): void { @@ -363,10 +348,6 @@ class Style extends WriterPart /** * Write Cell Style Xf. - * - * @param XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Style\Style $style Style - * @param Spreadsheet $spreadsheet Workbook */ private function writeCellStyleXf(XMLWriter $objWriter, \PhpOffice\PhpSpreadsheet\Style\Style $style, Spreadsheet $spreadsheet): void { @@ -438,9 +419,6 @@ class Style extends WriterPart /** * Write Cell Style Dxf. - * - * @param XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Style\Style $style Style */ private function writeCellStyleDxf(XMLWriter $objWriter, \PhpOffice\PhpSpreadsheet\Style\Style $style): void { @@ -508,9 +486,7 @@ class Style extends WriterPart /** * Write BorderPr. * - * @param XMLWriter $objWriter XML Writer * @param string $name Element name - * @param Border $border Border style */ private function writeBorderPr(XMLWriter $objWriter, $name, Border $border): void { @@ -531,8 +507,6 @@ class Style extends WriterPart /** * Write NumberFormat. * - * @param XMLWriter $objWriter XML Writer - * @param NumberFormat $numberFormat Number Format * @param int $id Number Format identifier */ private function writeNumFmt(XMLWriter $objWriter, NumberFormat $numberFormat, $id = 0): void diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Workbook.php b/src/PhpSpreadsheet/Writer/Xlsx/Workbook.php index 20ca1aa4..f9d7197d 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/Workbook.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/Workbook.php @@ -66,8 +66,6 @@ class Workbook extends WriterPart /** * Write file version. - * - * @param XMLWriter $objWriter XML Writer */ private function writeFileVersion(XMLWriter $objWriter): void { @@ -81,8 +79,6 @@ class Workbook extends WriterPart /** * Write WorkbookPr. - * - * @param XMLWriter $objWriter XML Writer */ private function writeWorkbookPr(XMLWriter $objWriter): void { @@ -99,8 +95,6 @@ class Workbook extends WriterPart /** * Write BookViews. - * - * @param XMLWriter $objWriter XML Writer */ private function writeBookViews(XMLWriter $objWriter, Spreadsheet $spreadsheet): void { @@ -127,8 +121,6 @@ class Workbook extends WriterPart /** * Write WorkbookProtection. - * - * @param XMLWriter $objWriter XML Writer */ private function writeWorkbookProtection(XMLWriter $objWriter, Spreadsheet $spreadsheet): void { @@ -153,7 +145,6 @@ class Workbook extends WriterPart /** * Write calcPr. * - * @param XMLWriter $objWriter XML Writer * @param bool $recalcRequired Indicate whether formulas should be recalculated before writing */ private function writeCalcPr(XMLWriter $objWriter, $recalcRequired = true): void @@ -175,8 +166,6 @@ class Workbook extends WriterPart /** * Write sheets. - * - * @param XMLWriter $objWriter XML Writer */ private function writeSheets(XMLWriter $objWriter, Spreadsheet $spreadsheet): void { @@ -200,7 +189,6 @@ class Workbook extends WriterPart /** * Write sheet. * - * @param XMLWriter $objWriter XML Writer * @param string $worksheetName Sheet name * @param int $worksheetId Sheet id * @param int $relId Relationship ID diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Worksheet.php b/src/PhpSpreadsheet/Writer/Xlsx/Worksheet.php index 286ebe7e..204c4953 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/Worksheet.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/Worksheet.php @@ -130,9 +130,6 @@ class Worksheet extends WriterPart /** * Write SheetPr. - * - * @param XMLWriter $objWriter XML Writer - * @param PhpspreadsheetWorksheet $worksheet Worksheet */ private function writeSheetPr(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -176,8 +173,6 @@ class Worksheet extends WriterPart /** * Write Dimension. - * - * @param XMLWriter $objWriter XML Writer */ private function writeDimension(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -189,8 +184,6 @@ class Worksheet extends WriterPart /** * Write SheetViews. - * - * @param XMLWriter $objWriter XML Writer */ private function writeSheetViews(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -303,8 +296,6 @@ class Worksheet extends WriterPart /** * Write SheetFormatPr. - * - * @param XMLWriter $objWriter XML Writer */ private function writeSheetFormatPr(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -355,9 +346,6 @@ class Worksheet extends WriterPart /** * Write Cols. - * - * @param XMLWriter $objWriter XML Writer - * @param PhpspreadsheetWorksheet $worksheet Worksheet */ private function writeCols(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -419,8 +407,6 @@ class Worksheet extends WriterPart /** * Write SheetProtection. - * - * @param XMLWriter $objWriter XML Writer */ private function writeSheetProtection(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -605,8 +591,6 @@ class Worksheet extends WriterPart /** * Write ConditionalFormatting. - * - * @param XMLWriter $objWriter XML Writer */ private function writeConditionalFormatting(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -671,8 +655,6 @@ class Worksheet extends WriterPart /** * Write DataValidations. - * - * @param XMLWriter $objWriter XML Writer */ private function writeDataValidations(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -736,8 +718,6 @@ class Worksheet extends WriterPart /** * Write Hyperlinks. - * - * @param XMLWriter $objWriter XML Writer */ private function writeHyperlinks(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -776,8 +756,6 @@ class Worksheet extends WriterPart /** * Write ProtectedRanges. - * - * @param XMLWriter $objWriter XML Writer */ private function writeProtectedRanges(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -803,8 +781,6 @@ class Worksheet extends WriterPart /** * Write MergeCells. - * - * @param XMLWriter $objWriter XML Writer */ private function writeMergeCells(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -826,8 +802,6 @@ class Worksheet extends WriterPart /** * Write PrintOptions. - * - * @param XMLWriter $objWriter XML Writer */ private function writePrintOptions(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -850,8 +824,6 @@ class Worksheet extends WriterPart /** * Write PageMargins. - * - * @param XMLWriter $objWriter XML Writer */ private function writePageMargins(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -868,9 +840,6 @@ class Worksheet extends WriterPart /** * Write AutoFilter. - * - * @param XMLWriter $objWriter XML Writer - * @param PhpspreadsheetWorksheet $worksheet Worksheet */ private function writeAutoFilter(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -967,9 +936,6 @@ class Worksheet extends WriterPart /** * Write PageSetup. - * - * @param XMLWriter $objWriter XML Writer - * @param PhpspreadsheetWorksheet $worksheet Worksheet */ private function writePageSetup(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -1007,9 +973,6 @@ class Worksheet extends WriterPart /** * Write Header / Footer. - * - * @param XMLWriter $objWriter XML Writer - * @param PhpspreadsheetWorksheet $worksheet Worksheet */ private function writeHeaderFooter(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -1031,9 +994,6 @@ class Worksheet extends WriterPart /** * Write Breaks. - * - * @param XMLWriter $objWriter XML Writer - * @param PhpspreadsheetWorksheet $worksheet Worksheet */ private function writeBreaks(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -1088,8 +1048,6 @@ class Worksheet extends WriterPart /** * Write SheetData. * - * @param XMLWriter $objWriter XML Writer - * @param PhpspreadsheetWorksheet $worksheet Worksheet * @param string[] $stringTable String table */ private function writeSheetData(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet, array $stringTable): void @@ -1273,8 +1231,6 @@ class Worksheet extends WriterPart /** * Write Cell. * - * @param XMLWriter $objWriter XML Writer - * @param PhpspreadsheetWorksheet $worksheet Worksheet * @param string $cellAddress Cell Address * @param string[] $flippedStringTable String table (flipped), for faster index searching */ @@ -1328,8 +1284,6 @@ class Worksheet extends WriterPart /** * Write Drawings. * - * @param XMLWriter $objWriter XML Writer - * @param PhpspreadsheetWorksheet $worksheet Worksheet * @param bool $includeCharts Flag indicating if we should include drawing details for charts */ private function writeDrawings(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet, $includeCharts = false): void @@ -1358,9 +1312,6 @@ class Worksheet extends WriterPart /** * Write LegacyDrawing. - * - * @param XMLWriter $objWriter XML Writer - * @param PhpspreadsheetWorksheet $worksheet Worksheet */ private function writeLegacyDrawing(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void { @@ -1374,9 +1325,6 @@ class Worksheet extends WriterPart /** * Write LegacyDrawingHF. - * - * @param XMLWriter $objWriter XML Writer - * @param PhpspreadsheetWorksheet $worksheet Worksheet */ private function writeLegacyDrawingHF(XMLWriter $objWriter, PhpspreadsheetWorksheet $worksheet): void {