PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Shared/ZipStreamWrapper.php

Doc Comments +3 added lines, -3 removed lines

@@ -101,7 +101,7 @@ 
     /**
      * Implements support for fstat().
      *
-     * @return  boolean
+     * @return  string
      */
     public function statName()
     {
@@ -111,7 +111,7 @@ 
     /**
      * Implements support for fstat().
      *
-     * @return  boolean
+     * @return  string
      */
     public function url_stat() // @codingStandardsIgnoreLine
     {
@@ -167,7 +167,7 @@ 
      *
      * @param    int        $offset    byte offset
      * @param    int        $whence    SEEK_SET, SEEK_CUR or SEEK_END
-     * @return    bool
+     * @return    boolean|null
      */
     public function stream_seek($offset, $whence) // @codingStandardsIgnoreLine
     {

src/PhpSpreadsheet/Spreadsheet.php

Doc Comments +11 added lines, -10 removed lines

@@ -137,7 +137,7 @@ 
     /**
     * The workbook has macros ?
     *
-    * @return true if workbook has macros, false if not
+    * @return boolean if workbook has macros, false if not
     */
     public function hasMacros()
     {
@@ -178,7 +178,7 @@ 
     /**
     * Set the macros certificate
     *
-    * @param string|null $Certificate
+    * @param string|null $certificate
     */
     public function setMacrosCertificate($certificate = null)
     {
@@ -233,6 +233,7 @@ 
     * retrieve ribbon XML Data
     *
     * return string|null|array
+    * @return string
     */
     public function getRibbonXMLData($what = 'all') //we need some constants here...
     {
@@ -308,7 +309,7 @@ 
     /**
     * This workbook have a custom UI ?
     *
-    * @return true|false
+    * @return boolean
     */
     public function hasRibbon()
     {
@@ -318,7 +319,7 @@ 
     /**
     * This workbook have additionnal object for the ribbon ?
     *
-    * @return true|false
+    * @return boolean
     */
     public function hasRibbonBinObjects()
     {
@@ -617,7 +618,7 @@ 
      * Get index for sheet
      *
      * @param  Worksheet $pSheet
-     * @return Sheet index
+     * @return integer index
      * @throws Exception
      */
     public function getIndex(Worksheet $pSheet)
@@ -636,7 +637,7 @@ 
      *
      * @param  string $sheetName Sheet name to modify index for
      * @param  int $newIndex New index for the sheet
-     * @return New sheet index
+     * @return integer sheet index
      * @throws Exception
      */
     public function setIndexByName($sheetName, $newIndex)
@@ -778,7 +779,7 @@ 
      * Add named range
      *
      * @param  NamedRange $namedRange
-     * @return PHPExcel
+     * @return boolean
      */
     public function addNamedRange(NamedRange $namedRange)
     {
@@ -823,7 +824,7 @@ 
      *
      * @param  string  $namedRange
      * @param  Worksheet|null  $pSheet  Scope: use null for global scope.
-     * @return PHPExcel
+     * @return Spreadsheet
      */
     public function removeNamedRange($namedRange, Worksheet $pSheet = null)
     {
@@ -842,7 +843,7 @@ 
     /**
      * Get worksheet iterator
      *
-     * @return WorksheetIterator
+     * @return Worksheet\Iterator
      */
     public function getWorksheetIterator()
     {
@@ -852,7 +853,7 @@ 
     /**
      * Copy workbook (!= clone!)
      *
-     * @return PHPExcel
+     * @return Spreadsheet
      */
     public function copy()
     {

src/PhpSpreadsheet/Style.php

Doc Comments +1 added lines, -1 removed lines

@@ -150,7 +150,7 @@
     /**
      * Get parent. Only used for style supervisor
      *
-     * @return PHPExcel
+     * @return Style
      */
     public function getParent()
     {

src/PhpSpreadsheet/Style/Conditional.php

Doc Comments +2 added lines, -2 removed lines

@@ -100,7 +100,7 @@ 
     /**
      * Get Condition type
      *
-     * @return string
+     * @return integer
      */
     public function getConditionType()
     {
@@ -122,7 +122,7 @@ 
     /**
      * Get Operator type
      *
-     * @return string
+     * @return integer
      */
     public function getOperatorType()
     {

src/PhpSpreadsheet/Worksheet.php

Doc Comments +17 added lines, -17 removed lines

@@ -329,7 +329,7 @@ 
     /**
      * Create a new worksheet
      *
-     * @param PHPExcel        $pParent
+     * @param PHPExcel        $parent
      * @param string        $pTitle
      */
     public function __construct(Spreadsheet $parent = null, $pTitle = 'Worksheet')
@@ -586,7 +586,7 @@ 
      * Get a chart by its index position
      *
      * @param string $index Chart index position
-     * @return false|Chart
+     * @return null|Chart
      * @throws Exception
      */
     public function getChartByIndex($index = null)
@@ -768,7 +768,7 @@ 
     /**
      * Get parent
      *
-     * @return PHPExcel
+     * @return Spreadsheet
      */
     public function getParent()
     {
@@ -778,7 +778,7 @@ 
     /**
      * Re-bind parent
      *
-     * @param PHPExcel $parent
+     * @param Spreadsheet $parent
      * @return Worksheet
      */
     public function rebindParent(Spreadsheet $parent)
@@ -1078,7 +1078,7 @@ 
      * Set a cell value
      *
      * @param string $pCoordinate Coordinate of the cell
-     * @param mixed $pValue Value of the cell
+     * @param integer $pValue Value of the cell
      * @param bool $returnCell   Return the worksheet (false, default) or the cell (true)
      * @return Worksheet|Cell    Depending on the last parameter being specified
      */
@@ -1091,8 +1091,8 @@ 
     /**
      * Set a cell value by using numeric cell coordinates
      *
-     * @param string $pColumn Numeric column coordinate of the cell (A = 0)
-     * @param string $pRow Numeric row coordinate of the cell
+     * @param integer $pColumn Numeric column coordinate of the cell (A = 0)
+     * @param integer $pRow Numeric row coordinate of the cell
      * @param mixed $pValue Value of the cell
      * @param bool $returnCell Return the worksheet (false, default) or the cell (true)
      * @return Worksheet|Cell    Depending on the last parameter being specified
@@ -1122,8 +1122,8 @@ 
     /**
      * Set a cell value by using numeric cell coordinates
      *
-     * @param string $pColumn Numeric column coordinate of the cell
-     * @param string $pRow Numeric row coordinate of the cell
+     * @param integer $pColumn Numeric column coordinate of the cell
+     * @param integer $pRow Numeric row coordinate of the cell
      * @param mixed $pValue Value of the cell
      * @param string $pDataType Explicit data type
      * @param bool $returnCell Return the worksheet (false, default) or the cell (true)
@@ -1183,8 +1183,8 @@ 
     /**
      * Get cell at a specific coordinate by using numeric cell coordinates
      *
-     * @param  string $pColumn Numeric column coordinate of the cell
-     * @param string $pRow Numeric row coordinate of the cell
+     * @param  integer $pColumn Numeric column coordinate of the cell
+     * @param integer $pRow Numeric row coordinate of the cell
      * @param boolean $createIfNotExists  Flag indicating whether a new cell should be created if it doesn't
      *                                       already exist, or a null should be returned instead
      * @return null|Cell Cell that was found/created or null
@@ -1291,8 +1291,8 @@ 
     /**
      * Cell at a specific coordinate by using numeric cell coordinates exists?
      *
-     * @param string $pColumn Numeric column coordinate of the cell
-     * @param string $pRow Numeric row coordinate of the cell
+     * @param integer $pColumn Numeric column coordinate of the cell
+     * @param integer $pRow Numeric row coordinate of the cell
      * @return boolean
      */
     public function cellExistsByColumnAndRow($pColumn = 0, $pRow = 1)
@@ -1351,7 +1351,7 @@ 
     /**
      * Get column dimension at a specific column by using numeric cell coordinates
      *
-     * @param string $pColumn Numeric column coordinate of the cell
+     * @param integer $pColumn Numeric column coordinate of the cell
      * @return Worksheet\ColumnDimension
      */
     public function getColumnDimensionByColumn($pColumn = 0)
@@ -1472,7 +1472,7 @@ 
     /**
      * Set conditional styles
      *
-     * @param $pCoordinate string E.g. 'A1'
+     * @param string $pCoordinate string E.g. 'A1'
      * @param $pValue Style\Conditional[]
      * @return Worksheet
      */
@@ -1893,7 +1893,7 @@ 
     /**
      *    Set AutoFilter
      *
-     *    @param    Worksheet\AutoFilter|string   $pValue
+     *    @param    string   $pValue
      *            A simple string containing a Cell range like 'A1:E10' is permitted for backward compatibility
      *    @throws Exception
      *    @return Worksheet
@@ -2903,7 +2903,7 @@ 
      * Define the code name of the sheet
      *
      * @param null|string Same rule as Title minus space not allowed (but, like Excel, change silently space to underscore)
-     * @return objWorksheet
+     * @return Worksheet
      * @throws Exception
     */
     public function setCodeName($pValue = null)

src/PhpSpreadsheet/Worksheet/AutoFilter.php

Doc Comments +6 added lines

@@ -467,6 +467,7 @@ 
      *
      *    @param    string                   $dynamicRuleType
      *    @param    AutoFilter\Column        &$filterColumn
+     * @param AutoFilter\Column $filterColumn
      *    @return mixed[]
      */
     private function dynamicFilterDateRange($dynamicRuleType, &$filterColumn)
@@ -571,6 +572,11 @@ 
         return array('method' => 'filterTestInCustomDataSet', 'arguments' => array('filterRules' => $ruleValues, 'join' => AutoFilter\Column::AUTOFILTER_COLUMN_JOIN_AND));
     }
 
+    /**
+     * @param integer $columnID
+     * @param integer $startRow
+     * @param string $ruleType
+     */
     private function calculateTopTenValue($columnID, $startRow, $endRow, $ruleType, $ruleValue)
     {
         $range = $columnID.$startRow.':'.$columnID.$endRow;

src/PhpSpreadsheet/Worksheet/AutoFilter/Column/Rule.php

Doc Comments +1 added lines, -1 removed lines

@@ -286,7 +286,7 @@
      *
      *    @param   string        $pRuleType
      *    @throws  \PHPExcel\Exception
-     *    @return  \PHPExcel\Worksheet\AutoFilter\Column
+     *    @return  Rule
      */
     public function setRuleType($pRuleType = self::AUTOFILTER_RULETYPE_FILTER)
     {

src/PhpSpreadsheet/Worksheet/ColumnCellIterator.php

Doc Comments +1 added lines, -1 removed lines

@@ -136,7 +136,7 @@
     /**
      * Return the current cell in this worksheet column
      *
-     * @return Row
+     * @return null|\PHPExcel\Cell
      */
     public function current()
     {

src/PhpSpreadsheet/Worksheet/ColumnDimension.php

Doc Comments +2 added lines, -2 removed lines

@@ -69,7 +69,7 @@ 
     /**
      * Get ColumnIndex
      *
-     * @return string
+     * @return integer
      */
     public function getColumnIndex()
     {
@@ -101,7 +101,7 @@ 
     /**
      * Set Width
      *
-     * @param double $pValue
+     * @param integer $pValue
      * @return ColumnDimension
      */
     public function setWidth($pValue = -1)