Fixed coding standard with return typehints

Author: aswinkumar863

src/PhpSpreadsheet/Worksheet/Table.php

@@ -73,20 +73,16 @@ public function __construct(string $range = '', ?Worksheet $worksheet = null)
 
     /**
      * Get Table name.
-     *
-     * @return string
      */
-    public function getName()
+    public function getName(): string
     {
         return $this->name;
     }
 
     /**
      * Set Table name.
-     *
-     * @return $this
      */
-    public function setName(string $name)
+    public function setName(string $name): self
     {
         $name = trim($name);
 
@@ -117,20 +113,16 @@ public function setName(string $name)
 
     /**
      * Get show Header Row.
-     *
-     * @return bool
      */
-    public function getShowHeaderRow()
+    public function getShowHeaderRow(): bool
     {
         return $this->showHeaderRow;
     }
 
     /**
      * Set show Header Row.
-     *
-     * @return  $this
      */
-    public function setShowHeaderRow(bool $showHeaderRow)
+    public function setShowHeaderRow(bool $showHeaderRow): self
     {
         $this->showHeaderRow = $showHeaderRow;
 
@@ -139,20 +131,16 @@ public function setShowHeaderRow(bool $showHeaderRow)
 
     /**
      * Get show Totals Row.
-     *
-     * @return bool
      */
-    public function getShowTotalsRow()
+    public function getShowTotalsRow(): bool
     {
         return $this->showTotalsRow;
     }
 
     /**
      * Set show Totals Row.
-     *
-     * @return  $this
      */
-    public function setShowTotalsRow(bool $showTotalsRow)
+    public function setShowTotalsRow(bool $showTotalsRow): self
     {
         $this->showTotalsRow = $showTotalsRow;
 
@@ -161,18 +149,14 @@ public function setShowTotalsRow(bool $showTotalsRow)
 
     /**
      * Get Table Range.
-     *
-     * @return string
      */
-    public function getRange()
+    public function getRange(): string
     {
         return $this->range;
     }
 
     /**
      * Set Table Cell Range.
-     *
-     * @return $this
      */
     public function setRange(string $range): self
     {
@@ -210,8 +194,6 @@ public function setRange(string $range): self
 
     /**
      * Set Table Cell Range to max row.
-     *
-     * @return $this
      */
     public function setRangeToMaxRow(): self
     {
@@ -228,20 +210,16 @@ public function setRangeToMaxRow(): self
 
     /**
      * Get Table's Worksheet.
-     *
-     * @return null|Worksheet
      */
-    public function getWorksheet()
+    public function getWorksheet(): ?Worksheet
     {
         return $this->workSheet;
     }
 
     /**
      * Set Table's Worksheet.
-     *
-     * @return $this
      */
-    public function setWorksheet(?Worksheet $worksheet = null)
+    public function setWorksheet(?Worksheet $worksheet = null): self
     {
         if ($this->name !== '' && $worksheet !== null) {
             $spreadsheet = $worksheet->getParent();
@@ -265,7 +243,7 @@ public function setWorksheet(?Worksheet $worksheet = null)
      *
      * @return Table\Column[]
      */
-    public function getColumns()
+    public function getColumns(): array
     {
         return $this->columns;
     }
@@ -277,7 +255,7 @@ public function getColumns()
      *
      * @return int The column offset within the table range
      */
-    public function isColumnInRange($column)
+    public function isColumnInRange(string $column): int
     {
         if (empty($this->range)) {
             throw new PhpSpreadsheetException('No table range is defined.');
@@ -299,7 +277,7 @@ public function isColumnInRange($column)
      *
      * @return int The offset of the specified column within the table range
      */
-    public function getColumnOffset($column)
+    public function getColumnOffset($column): int
     {
         return $this->isColumnInRange($column);
     }
@@ -308,10 +286,8 @@ public function getColumnOffset($column)
      * Get a specified Table Column.
      *
      * @param string $column Column name (e.g. A)
-     *
-     * @return Table\Column
      */
-    public function getColumn($column)
+    public function getColumn($column): Table\Column
     {
         $this->isColumnInRange($column);
 
@@ -326,10 +302,8 @@ public function getColumn($column)
      * Get a specified Table Column by it's offset.
      *
      * @param int $columnOffset Column offset within range (starting from 0)
-     *
-     * @return Table\Column
      */
-    public function getColumnByOffset($columnOffset)
+    public function getColumnByOffset($columnOffset): Table\Column
     {
         [$rangeStart, $rangeEnd] = Coordinate::rangeBoundaries($this->range);
         $pColumn = Coordinate::stringFromColumnIndex($rangeStart[0] + $columnOffset);
@@ -342,10 +316,8 @@ public function getColumnByOffset($columnOffset)
      *
      * @param string|Table\Column $columnObjectOrString
      *            A simple string containing a Column ID like 'A' is permitted
-     *
-     * @return $this
      */
-    public function setColumn($columnObjectOrString)
+    public function setColumn($columnObjectOrString): self
     {
         if ((is_string($columnObjectOrString)) && (!empty($columnObjectOrString))) {
             $column = $columnObjectOrString;
@@ -371,10 +343,8 @@ public function setColumn($columnObjectOrString)
      * Clear a specified Table Column.
      *
      * @param string $column Column name (e.g. A)
-     *
-     * @return $this
      */
-    public function clearColumn($column)
+    public function clearColumn($column): self
     {
         $this->isColumnInRange($column);
 
@@ -394,10 +364,8 @@ public function clearColumn($column)
      *
      * @param string $fromColumn Column name (e.g. A)
      * @param string $toColumn Column name (e.g. B)
-     *
-     * @return $this
      */
-    public function shiftColumn($fromColumn, $toColumn)
+    public function shiftColumn($fromColumn, $toColumn): self
     {
         $fromColumn = strtoupper($fromColumn);
         $toColumn = strtoupper($toColumn);
@@ -417,20 +385,16 @@ public function shiftColumn($fromColumn, $toColumn)
 
     /**
      * Get table Style.
-     *
-     * @return TableStyle
      */
-    public function getStyle()
+    public function getStyle(): Table\TableStyle
     {
         return $this->style;
     }
 
     /**
      * Set table Style.
-     *
-     * @return  $this
      */
-    public function setStyle(TableStyle $style)
+    public function setStyle(TableStyle $style): self
     {
         $this->style = $style;
 

src/PhpSpreadsheet/Worksheet/Table/Column.php

@@ -69,10 +69,8 @@ public function __construct($column, ?Table $table = null)
 
     /**
      * Get Table column index as string eg: 'A'.
-     *
-     * @return string
      */
-    public function getColumnIndex()
+    public function getColumnIndex(): string
     {
         return $this->columnIndex;
     }
@@ -81,10 +79,8 @@ public function getColumnIndex()
      * Set Table column index as string eg: 'A'.
      *
      * @param string $column Column (e.g. A)
-     *
-     * @return $this
      */
-    public function setColumnIndex($column)
+    public function setColumnIndex($column): self
     {
         // Uppercase coordinate
         $column = strtoupper($column);
@@ -99,20 +95,16 @@ public function setColumnIndex($column)
 
     /**
      * Get show Filter Button.
-     *
-     * @return bool
      */
-    public function getShowFilterButton()
+    public function getShowFilterButton(): bool
     {
         return $this->showFilterButton;
     }
 
     /**
      * Set show Filter Button.
-     *
-     * @return  $this
      */
-    public function setShowFilterButton(bool $showFilterButton)
+    public function setShowFilterButton(bool $showFilterButton): self
     {
         $this->showFilterButton = $showFilterButton;
 
@@ -121,20 +113,16 @@ public function setShowFilterButton(bool $showFilterButton)
 
     /**
      * Get total Row Label.
-     *
-     * @return string
      */
-    public function getTotalsRowLabel()
+    public function getTotalsRowLabel(): ?string
     {
         return $this->totalsRowLabel;
     }
 
     /**
      * Set total Row Label.
-     *
-     * @return  $this
      */
-    public function setTotalsRowLabel(string $totalsRowLabel)
+    public function setTotalsRowLabel(string $totalsRowLabel): self
     {
         $this->totalsRowLabel = $totalsRowLabel;
 
@@ -143,20 +131,16 @@ public function setTotalsRowLabel(string $totalsRowLabel)
 
     /**
      * Get total Row Function.
-     *
-     * @return string
      */
-    public function getTotalsRowFunction()
+    public function getTotalsRowFunction(): ?string
     {
         return $this->totalsRowFunction;
     }
 
     /**
      * Set total Row Function.
-     *
-     * @return  $this
      */
-    public function setTotalsRowFunction(string $totalsRowFunction)
+    public function setTotalsRowFunction(string $totalsRowFunction): self
     {
         $this->totalsRowFunction = $totalsRowFunction;
 
@@ -165,20 +149,16 @@ public function setTotalsRowFunction(string $totalsRowFunction)
 
     /**
      * Get total Row Formula.
-     *
-     * @return string
      */
-    public function getTotalsRowFormula()
+    public function getTotalsRowFormula(): ?string
     {
         return $this->totalsRowFormula;
     }
 
     /**
      * Set total Row Formula.
-     *
-     * @return  $this
      */
-    public function setTotalsRowFormula(string $totalsRowFormula)
+    public function setTotalsRowFormula(string $totalsRowFormula): self
     {
         $this->totalsRowFormula = $totalsRowFormula;
 
@@ -187,20 +167,16 @@ public function setTotalsRowFormula(string $totalsRowFormula)
 
     /**
      * Get column Formula.
-     *
-     * @return string
      */
-    public function getColumnFormula()
+    public function getColumnFormula(): ?string
     {
         return $this->columnFormula;
     }
 
     /**
      * Set column Formula.
-     *
-     * @return  $this
      */
-    public function setColumnFormula(string $columnFormula)
+    public function setColumnFormula(string $columnFormula): self
     {
         $this->columnFormula = $columnFormula;
 
@@ -209,20 +185,16 @@ public function setColumnFormula(string $columnFormula)
 
     /**
      * Get this Column's Table.
-     *
-     * @return null|Table
      */
-    public function getTable()
+    public function getTable(): ?Table
     {
         return $this->table;
     }
 
     /**
      * Set this Column's Table.
-     *
-     * @return $this
      */
-    public function setTable(?Table $table = null)
+    public function setTable(?Table $table = null): self
     {
         $this->table = $table;