PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Reader/Excel2007.php

Doc Comments +18 added lines, -1 removed lines

@@ -285,6 +285,11 @@ 
         return isset($c->v) ? (string) $c->v : null;
     }
 
+    /**
+     * @param string $r
+     * @param string $cellDataType
+     * @param string $castBaseType
+     */
     private function castToFormula($c, $r, &$cellDataType, &$value, &$calculatedValue, &$sharedFormulas, $castBaseType)
     {
 //        echo 'Formula', PHP_EOL;
@@ -327,6 +332,9 @@ 
     }
 
 
+    /**
+     * @return string|null
+     */
     private function getFromZipArchive($archive, $fileName = '')
     {
         // Root-relative paths
@@ -356,7 +364,7 @@ 
      * Loads Spreadsheet from file
      *
      * @param     string         $pFilename
-     * @return    Spreadsheet
+     * @return    \PhpSpreadsheet\Spreadsheet
      * @throws    Exception
      */
     public function load($pFilename)
@@ -1921,6 +1929,9 @@ 
         return 'FF000000';
     }
 
+    /**
+     * @param \PhpSpreadsheet\Style $docStyle
+     */
     private static function readStyle($docStyle, $style)
     {
         // format code
@@ -2120,6 +2131,9 @@ 
         return $value;
     }
 
+    /**
+     * @param \PhpSpreadsheet\Spreadsheet $excel
+     */
     private function readRibbon($excel, $customUITarget, $zip)
     {
         $baseDir = dirname($customUITarget);
@@ -2172,6 +2186,9 @@ 
         return preg_replace('~[^/]+/\.\./~', '', dirname($base) . "/$add");
     }
 
+    /**
+     * @param string $style
+     */
     private static function toCSSArray($style)
     {
         $style = str_replace(array("\r","\n"), "", $style);

Spacing +5 added lines, -5 removed lines

@@ -136,7 +136,7 @@ 
                             'SimpleXMLElement',
                             \PhpSpreadsheet\Settings::getLibXmlLoaderOptions()
                         )
-                    );  //~ http://schemas.openxmlformats.org/spreadsheetml/2006/main"
+                    ); //~ http://schemas.openxmlformats.org/spreadsheetml/2006/main"
 
                     if ($xmlWorkbook->sheets) {
                         foreach ($xmlWorkbook->sheets->sheet as $eleSheet) {
@@ -541,7 +541,7 @@ 
                     }
 
                     if (!is_null($macros)) {
-                        $macrosCode = $this->getFromZipArchive($zip, 'xl/vbaProject.bin');//vbaProject.bin always in 'xl' dir and always named vbaProject.bin
+                        $macrosCode = $this->getFromZipArchive($zip, 'xl/vbaProject.bin'); //vbaProject.bin always in 'xl' dir and always named vbaProject.bin
                         if ($macrosCode !== false) {
                             $excel->setMacrosCode($macrosCode);
                             $excel->setHasMacros(true);
@@ -1313,7 +1313,7 @@ 
                                         foreach (\PhpSpreadsheet\Cell::extractAllCellReferencesInRange($hyperlink['ref']) as $cellReference) {
                                             $cell = $docSheet->getCell($cellReference);
                                             if (isset($linkRel['id'])) {
-                                                $hyperlinkUrl = $hyperlinks[ (string) $linkRel['id'] ];
+                                                $hyperlinkUrl = $hyperlinks[(string) $linkRel['id']];
                                                 if (isset($hyperlink['location'])) {
                                                     $hyperlinkUrl .= '#' . (string) $hyperlink['location'];
                                                 }
@@ -1740,10 +1740,10 @@ 
                                                 }
                                                 break;
                                             case '_xlnm.Print_Area':
-                                                $rangeSets = explode(',', $extractedRange);        // FIXME: what if sheetname contains comma?
+                                                $rangeSets = explode(',', $extractedRange); // FIXME: what if sheetname contains comma?
                                                 $newRangeSets = [];
                                                 foreach ($rangeSets as $rangeSet) {
-                                                    $range = explode('!', $rangeSet);    // FIXME: what if sheetname contains exclamation mark?
+                                                    $range = explode('!', $rangeSet); // FIXME: what if sheetname contains exclamation mark?
                                                     $rangeSet = isset($range[1]) ? $range[1] : $range[0];
                                                     if (strpos($rangeSet, ':') === false) {
                                                         $rangeSet = $rangeSet . ':' . $rangeSet;

src/PhpSpreadsheet/Reader/Excel2007/Chart.php

Doc Comments +14 added lines

@@ -26,6 +26,10 @@ 
  */
 class Chart
 {
+    /**
+     * @param string $name
+     * @param string $format
+     */
     private static function getAttribute($component, $name, $format)
     {
         $attributes = $component->attributes();
@@ -53,6 +57,10 @@ 
         }
     }
 
+    /**
+     * @param \SimpleXMLElement $chartElements
+     * @param string $chartName
+     */
     public static function readChart($chartElements, $chartName)
     {
         $namespacesChartMeta = $chartElements->getNamespaces(true);
@@ -195,6 +203,9 @@ 
         return $chart;
     }
 
+    /**
+     * @param string $type
+     */
     private static function chartTitle($titleDetails, $namespacesChartMeta, $type)
     {
         $caption = array();
@@ -481,6 +492,9 @@ 
         return $plotAttributes;
     }
 
+    /**
+     * @param \PhpSpreadsheet\Chart\Layout $plotArea
+     */
     private static function setChartAttributes($plotArea, $plotAttributes)
     {
         foreach ($plotAttributes as $plotAttributeKey => $plotAttributeValue) {

src/PhpSpreadsheet/Reader/Gnumeric.php

Doc Comments +5 added lines, -2 removed lines

@@ -163,6 +163,9 @@ 
         return $worksheetInfo;
     }
 
+    /**
+     * @param string $filename
+     */
     private function gzfileGetContents($filename)
     {
         $file = @gzopen($filename, 'rb');
@@ -180,7 +183,7 @@ 
      * Loads PhpSpreadsheet from file
      *
      * @param     string         $pFilename
-     * @return     PhpSpreadsheet
+     * @return     \PhpSpreadsheet\Spreadsheet
      * @throws     Exception
      */
     public function load($pFilename)
@@ -197,7 +200,7 @@ 
      *
      * @param     string         $pFilename
      * @param    \PhpSpreadsheet\Spreadsheet    $spreadsheet
-     * @return     PhpSpreadsheet
+     * @return     \PhpSpreadsheet\Spreadsheet
      * @throws     Exception
      */
     public function loadIntoExisting($pFilename, \PhpSpreadsheet\Spreadsheet $spreadsheet)

Spacing +6 added lines, -6 removed lines

@@ -102,7 +102,7 @@ 
         $worksheetNames = [];
         while ($xml->read()) {
             if ($xml->name == 'gnm:SheetName' && $xml->nodeType == XMLReader::ELEMENT) {
-                $xml->read();    //    Move onto the value node
+                $xml->read(); //    Move onto the value node
                 $worksheetNames[] = (string) $xml->value;
             } elseif ($xml->name == 'gnm:Sheets') {
                 //    break out of the loop once we've got our sheet names rather than parse the entire file
@@ -143,14 +143,14 @@ 
 
                 while ($xml->read()) {
                     if ($xml->name == 'gnm:Name' && $xml->nodeType == XMLReader::ELEMENT) {
-                        $xml->read();    //    Move onto the value node
+                        $xml->read(); //    Move onto the value node
                         $tmpInfo['worksheetName'] = (string) $xml->value;
                     } elseif ($xml->name == 'gnm:MaxCol' && $xml->nodeType == XMLReader::ELEMENT) {
-                        $xml->read();    //    Move onto the value node
+                        $xml->read(); //    Move onto the value node
                         $tmpInfo['lastColumnIndex'] = (int) $xml->value;
                         $tmpInfo['totalColumns'] = (int) $xml->value + 1;
                     } elseif ($xml->name == 'gnm:MaxRow' && $xml->nodeType == XMLReader::ELEMENT) {
-                        $xml->read();    //    Move onto the value node
+                        $xml->read(); //    Move onto the value node
                         $tmpInfo['totalRows'] = (int) $xml->value + 1;
                         break;
                     }
@@ -349,7 +349,7 @@ 
                 if (isset($sheet->PrintInformation->Margins)) {
                     foreach ($sheet->PrintInformation->Margins->children('gnm', true) as $key => $margin) {
                         $marginAttributes = $margin->attributes();
-                        $marginSize = 72 / 100;    //    Default
+                        $marginSize = 72 / 100; //    Default
                         switch ($marginAttributes['PrefUnit']) {
                             case 'mm':
                                 $marginSize = intval($marginAttributes['Points']) / 100;
@@ -435,7 +435,7 @@ 
                             break;
                         case '20':        //    Boolean
                             $type = \PhpSpreadsheet\Cell\DataType::TYPE_BOOL;
-                            $cell = ($cell == 'TRUE') ? true: false;
+                            $cell = ($cell == 'TRUE') ? true : false;
                             break;
                         case '30':        //    Integer
                             $cell = intval($cell);

src/PhpSpreadsheet/Reader/HTML.php

Doc Comments +7 added lines, -1 removed lines

@@ -135,7 +135,7 @@ 
      * Loads PhpSpreadsheet from file
      *
      * @param  string                    $pFilename
-     * @return PhpSpreadsheet
+     * @return \PhpSpreadsheet\Spreadsheet
      * @throws Exception
      */
     public function load($pFilename)
@@ -217,6 +217,12 @@ 
         $cellContent = (string) '';
     }
 
+    /**
+     * @param \PhpSpreadsheet\Worksheet $sheet
+     * @param integer $row
+     * @param string $column
+     * @param string $cellContent
+     */
     protected function processDomElement(DOMNode $element, $sheet, &$row, &$column, &$cellContent, $format = null)
     {
         foreach ($element->childNodes as $child) {

src/PhpSpreadsheet/Shared/Font.php

Doc Comments +3 added lines, -2 removed lines

@@ -237,7 +237,7 @@ 
      * Calculate an (approximate) OpenXML column width, based on font size and text contained
      *
      * @param     \PhpSpreadsheet\Style\Font            $font            Font object
-     * @param     \PhpSpreadsheet\RichText|string    $cellText        Text to calculate width
+     * @param     string    $cellText        Text to calculate width
      * @param     integer                        $rotation        Rotation angle
      * @param     \PhpSpreadsheet\Style\Font|NULL    $defaultFont    Font object
      * @return     integer        Column width
@@ -406,7 +406,7 @@ 
      * Calculate an (approximate) pixel size, based on centimeter size
      *
      * @param     int        $sizeInCm    Font size (in centimeters)
-     * @return     int        Size (in pixels)
+     * @return     double        Size (in pixels)
      */
     public static function centimeterSizeToPixels($sizeInCm = 1)
     {
@@ -417,6 +417,7 @@ 
      * Returns the font path given the font
      *
      * @param \PhpSpreadsheet\Style\Font
+     * @param \PhpSpreadsheet\Style\Font $font
      * @return string Path to TrueType font file
      */
     public static function getTrueTypeFontFileFromFont($font)

Indentation +27 added lines, -27 removed lines

@@ -143,40 +143,40 @@
      */
     public static $defaultColumnWidths = [
         'Arial' => [
-             1 => ['px' => 24, 'width' => 12.00000000],
-             2 => ['px' => 24, 'width' => 12.00000000],
-             3 => ['px' => 32, 'width' => 10.66406250],
-             4 => ['px' => 32, 'width' => 10.66406250],
-             5 => ['px' => 40, 'width' => 10.00000000],
-             6 => ['px' => 48, 'width' => 9.59765625],
-             7 => ['px' => 48, 'width' => 9.59765625],
-             8 => ['px' => 56, 'width' => 9.33203125],
-             9 => ['px' => 64, 'width' => 9.14062500],
+                1 => ['px' => 24, 'width' => 12.00000000],
+                2 => ['px' => 24, 'width' => 12.00000000],
+                3 => ['px' => 32, 'width' => 10.66406250],
+                4 => ['px' => 32, 'width' => 10.66406250],
+                5 => ['px' => 40, 'width' => 10.00000000],
+                6 => ['px' => 48, 'width' => 9.59765625],
+                7 => ['px' => 48, 'width' => 9.59765625],
+                8 => ['px' => 56, 'width' => 9.33203125],
+                9 => ['px' => 64, 'width' => 9.14062500],
             10 => ['px' => 64, 'width' => 9.14062500],
         ],
         'Calibri' => [
-             1 => ['px' => 24, 'width' => 12.00000000],
-             2 => ['px' => 24, 'width' => 12.00000000],
-             3 => ['px' => 32, 'width' => 10.66406250],
-             4 => ['px' => 32, 'width' => 10.66406250],
-             5 => ['px' => 40, 'width' => 10.00000000],
-             6 => ['px' => 48, 'width' => 9.59765625],
-             7 => ['px' => 48, 'width' => 9.59765625],
-             8 => ['px' => 56, 'width' => 9.33203125],
-             9 => ['px' => 56, 'width' => 9.33203125],
+                1 => ['px' => 24, 'width' => 12.00000000],
+                2 => ['px' => 24, 'width' => 12.00000000],
+                3 => ['px' => 32, 'width' => 10.66406250],
+                4 => ['px' => 32, 'width' => 10.66406250],
+                5 => ['px' => 40, 'width' => 10.00000000],
+                6 => ['px' => 48, 'width' => 9.59765625],
+                7 => ['px' => 48, 'width' => 9.59765625],
+                8 => ['px' => 56, 'width' => 9.33203125],
+                9 => ['px' => 56, 'width' => 9.33203125],
             10 => ['px' => 64, 'width' => 9.14062500],
             11 => ['px' => 64, 'width' => 9.14062500],
         ],
         'Verdana' => [
-             1 => ['px' => 24, 'width' => 12.00000000],
-             2 => ['px' => 24, 'width' => 12.00000000],
-             3 => ['px' => 32, 'width' => 10.66406250],
-             4 => ['px' => 32, 'width' => 10.66406250],
-             5 => ['px' => 40, 'width' => 10.00000000],
-             6 => ['px' => 48, 'width' => 9.59765625],
-             7 => ['px' => 48, 'width' => 9.59765625],
-             8 => ['px' => 64, 'width' => 9.14062500],
-             9 => ['px' => 72, 'width' => 9.00000000],
+                1 => ['px' => 24, 'width' => 12.00000000],
+                2 => ['px' => 24, 'width' => 12.00000000],
+                3 => ['px' => 32, 'width' => 10.66406250],
+                4 => ['px' => 32, 'width' => 10.66406250],
+                5 => ['px' => 40, 'width' => 10.00000000],
+                6 => ['px' => 48, 'width' => 9.59765625],
+                7 => ['px' => 48, 'width' => 9.59765625],
+                8 => ['px' => 64, 'width' => 9.14062500],
+                9 => ['px' => 72, 'width' => 9.00000000],
             10 => ['px' => 72, 'width' => 9.00000000],
         ],
     ];

Spacing +2 added lines, -2 removed lines

@@ -45,8 +45,8 @@
     const CHARSET_ANSI_JAPANESE_SHIFTJIS = 0x80;
     const CHARSET_ANSI_KOREAN_HANGUL = 0x81;
     const CHARSET_ANSI_KOREAN_JOHAB = 0x82;
-    const CHARSET_ANSI_CHINESE_SIMIPLIFIED = 0x86;        //    gb2312
-    const CHARSET_ANSI_CHINESE_TRADITIONAL = 0x88;        //    big5
+    const CHARSET_ANSI_CHINESE_SIMIPLIFIED = 0x86; //    gb2312
+    const CHARSET_ANSI_CHINESE_TRADITIONAL = 0x88; //    big5
     const CHARSET_ANSI_GREEK = 0xA1;
     const CHARSET_ANSI_TURKISH = 0xA2;
     const CHARSET_ANSI_VIETNAMESE = 0xA3;

src/PhpSpreadsheet/Worksheet.php

Doc Comments +16 added lines, -16 removed lines

@@ -328,7 +328,7 @@ 
     /**
      * Create a new worksheet
      *
-     * @param Spreadsheet        $Parent
+     * @param Spreadsheet        $parent
      * @param string        $pTitle
      */
     public function __construct(Spreadsheet $parent = null, $pTitle = 'Worksheet')
@@ -585,7 +585,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)
@@ -767,7 +767,7 @@ 
     /**
      * Get parent
      *
-     * @return PhpSpreadsheet
+     * @return Spreadsheet
      */
     public function getParent()
     {
@@ -1077,7 +1077,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
      */
@@ -1090,8 +1090,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
@@ -1121,8 +1121,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)
@@ -1182,8 +1182,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
@@ -1290,8 +1290,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)
@@ -1350,7 +1350,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)
@@ -1471,7 +1471,7 @@ 
     /**
      * Set conditional styles
      *
-     * @param $pCoordinate string E.g. 'A1'
+     * @param string $pCoordinate string E.g. 'A1'
      * @param $pValue Style\Conditional[]
      * @return Worksheet
      */
@@ -1892,7 +1892,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
@@ -2902,7 +2902,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)

Spacing +2 added lines, -2 removed lines

@@ -2962,7 +2962,7 @@ 
         if ($this->getCodeName() == $pValue) {
             return $this;
         }
-        $pValue = str_replace(' ', '_', $pValue);//Excel does this automatically without flinching, we are doing the same
+        $pValue = str_replace(' ', '_', $pValue); //Excel does this automatically without flinching, we are doing the same
         // Syntax check
         // throw an exception if not valid
         self::checkSheetCodeName($pValue);
@@ -2991,7 +2991,7 @@ 
                     }
                 }
 
-                $pValue = $pValue . '_' . $i;// ok, we have a valid name
+                $pValue = $pValue . '_' . $i; // ok, we have a valid name
                 //codeName is'nt used in formula : no need to call for an update
                 //return $this->setTitle($altTitle, $updateFormulaCellReferences);
             }

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

Doc Comments +1 added lines, -1 removed lines

@@ -285,7 +285,7 @@
      *
      *    @param   string        $pRuleType
      *    @throws  \PhpSpreadsheet\Exception
-     *    @return  \PhpSpreadsheet\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

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

src/PhpSpreadsheet/Worksheet/Drawing/Shadow.php

Doc Comments +1 added lines, -1 removed lines

@@ -229,7 +229,7 @@
     /**
      * Set Color
      *
-     * @param    \PhpSpreadsheet\Style_Color $pValue
+     * @param    \PhpSpreadsheet\Style\Color $pValue
      * @throws   \PhpSpreadsheet\Exception
      * @return   Shadow
      */