PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Chart/Renderer/JpGraph.php

Doc Comments +62 added lines

@@ -62,6 +62,9 @@ 
     private static $plotMark = 0;
 
 
+    /**
+     * @param string $markerID
+     */
     private function formatPointMarker($seriesPlot, $markerID)
     {
         $plotMarkKeys = array_keys(self::$markSet);
@@ -90,6 +93,9 @@ 
     }
 
 
+    /**
+     * @param integer $labelCount
+     */
     private function formatDataSetLabels($groupID, $datasetLabels, $labelCount, $rotation = '')
     {
         $datasetLabelFormatCode = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotCategoryByIndex(0)->getFormatCode();
@@ -120,6 +126,9 @@ 
     }
 
 
+    /**
+     * @param integer $seriesCount
+     */
     private function percentageSumCalculation($groupID, $seriesCount)
     {
         //    Adjust our values to a percentage value across all series in the group
@@ -152,6 +161,9 @@ 
     }
 
 
+    /**
+     * @param \PhpSpreadsheet\Chart\Title $captionElement
+     */
     private function getCaption($captionElement)
     {
         //    Read any caption
@@ -264,6 +276,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotLine($groupID, $filled = false, $combination = false, $dimensions = '2d')
     {
         $grouping = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotGrouping();
@@ -328,6 +343,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotBar($groupID, $dimensions = '2d')
     {
         $rotation = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotDirection();
@@ -414,6 +432,10 @@ 
     }
 
 
+    /**
+     * @param integer $groupID
+     * @param boolean $bubble
+     */
     private function renderPlotScatter($groupID, $bubble)
     {
         $grouping = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotGrouping();
@@ -460,6 +482,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotRadar($groupID)
     {
         $radarStyle = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle();
@@ -499,6 +524,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotContour($groupID)
     {
         $contourStyle = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotStyle();
@@ -520,6 +548,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupID
+     */
     private function renderPlotStock($groupID)
     {
         $seriesCount = $this->chart->getPlotArea()->getPlotGroupByIndex($groupID)->getPlotSeriesCount();
@@ -560,6 +591,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderAreaChart($groupCount, $dimensions = '2d')
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_line.php');
@@ -572,6 +606,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderLineChart($groupCount, $dimensions = '2d')
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_line.php');
@@ -584,6 +621,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderBarChart($groupCount, $dimensions = '2d')
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_bar.php');
@@ -596,6 +636,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderScatterChart($groupCount)
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_scatter.php');
@@ -610,6 +653,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderBubbleChart($groupCount)
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_scatter.php');
@@ -622,6 +668,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderPieChart($groupCount, $dimensions = '2d', $doughnut = false, $multiplePlots = false)
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_pie.php');
@@ -699,6 +748,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderRadarChart($groupCount)
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_radar.php');
@@ -711,6 +763,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderStockChart($groupCount)
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_stock.php');
@@ -723,6 +778,10 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     * @param string|null $dimensions
+     */
     private function renderContourChart($groupCount, $dimensions)
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_contour.php');
@@ -735,6 +794,9 @@ 
     }
 
 
+    /**
+     * @param integer $groupCount
+     */
     private function renderCombinationChart($groupCount, $dimensions, $outputDestination)
     {
         require_once(\PhpSpreadsheet\Settings::getChartRendererPath().'jpgraph_line.php');

src/PhpSpreadsheet/Document/Properties.php

Doc Comments +2 added lines, -2 removed lines

@@ -177,7 +177,7 @@ 
     /**
      * Get Created
      *
-     * @return datetime
+     * @return integer|null
      */
     public function getCreated()
     {
@@ -209,7 +209,7 @@ 
     /**
      * Get Modified
      *
-     * @return datetime
+     * @return integer|null
      */
     public function getModified()
     {

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);

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)

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)

src/PhpSpreadsheet/Spreadsheet.php

Doc Comments +11 added lines, -10 removed lines

@@ -136,7 +136,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()
     {
@@ -177,7 +177,7 @@ 
     /**
     * Set the macros certificate
     *
-    * @param string|null $Certificate
+    * @param string|null $certificate
     */
     public function setMacrosCertificate($certificate = null)
     {
@@ -232,6 +232,7 @@ 
     * retrieve ribbon XML Data
     *
     * return string|null|array
+    * @return string
     */
     public function getRibbonXMLData($what = 'all') //we need some constants here...
     {
@@ -307,7 +308,7 @@ 
     /**
     * This workbook have a custom UI ?
     *
-    * @return true|false
+    * @return boolean
     */
     public function hasRibbon()
     {
@@ -317,7 +318,7 @@ 
     /**
     * This workbook have additionnal object for the ribbon ?
     *
-    * @return true|false
+    * @return boolean
     */
     public function hasRibbonBinObjects()
     {
@@ -615,7 +616,7 @@ 
      * Get index for sheet
      *
      * @param  Worksheet $pSheet
-     * @return Sheet index
+     * @return integer index
      * @throws Exception
      */
     public function getIndex(Worksheet $pSheet)
@@ -634,7 +635,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)
@@ -776,7 +777,7 @@ 
      * Add named range
      *
      * @param  NamedRange $namedRange
-     * @return PhpSpreadsheet
+     * @return boolean
      */
     public function addNamedRange(NamedRange $namedRange)
     {
@@ -821,7 +822,7 @@ 
      *
      * @param  string  $namedRange
      * @param  Worksheet|null  $pSheet  Scope: use null for global scope.
-     * @return PhpSpreadsheet
+     * @return Spreadsheet
      */
     public function removeNamedRange($namedRange, Worksheet $pSheet = null)
     {
@@ -840,7 +841,7 @@ 
     /**
      * Get worksheet iterator
      *
-     * @return WorksheetIterator
+     * @return Worksheet\Iterator
      */
     public function getWorksheetIterator()
     {
@@ -850,7 +851,7 @@ 
     /**
      * Copy workbook (!= clone!)
      *
-     * @return PhpSpreadsheet
+     * @return Spreadsheet
      */
     public function copy()
     {

Indentation +79 added lines, -79 removed lines

@@ -99,65 +99,65 @@ 
     private $cellStyleXfCollection = array();
 
     /**
-    * hasMacros : this workbook have macros ?
-    *
-    * @var bool
-    */
+     * hasMacros : this workbook have macros ?
+     *
+     * @var bool
+     */
     private $hasMacros = false;
 
     /**
-    * macrosCode : all macros code (the vbaProject.bin file, this include form, code,  etc.), null if no macro
-    *
-    * @var binary
-    */
+     * macrosCode : all macros code (the vbaProject.bin file, this include form, code,  etc.), null if no macro
+     *
+     * @var binary
+     */
     private $macrosCode;
     /**
-    * macrosCertificate : if macros are signed, contains vbaProjectSignature.bin file, null if not signed
-    *
-    * @var binary
-    */
+     * macrosCertificate : if macros are signed, contains vbaProjectSignature.bin file, null if not signed
+     *
+     * @var binary
+     */
     private $macrosCertificate;
 
     /**
-    * ribbonXMLData : null if workbook is'nt Excel 2007 or not contain a customized UI
-    *
-    * @var null|string
-    */
+     * ribbonXMLData : null if workbook is'nt Excel 2007 or not contain a customized UI
+     *
+     * @var null|string
+     */
     private $ribbonXMLData;
 
     /**
-    * ribbonBinObjects : null if workbook is'nt Excel 2007 or not contain embedded objects (picture(s)) for Ribbon Elements
-    * ignored if $ribbonXMLData is null
-    *
-    * @var null|array
-    */
+     * ribbonBinObjects : null if workbook is'nt Excel 2007 or not contain embedded objects (picture(s)) for Ribbon Elements
+     * ignored if $ribbonXMLData is null
+     *
+     * @var null|array
+     */
     private $ribbonBinObjects;
 
     /**
-    * The workbook has macros ?
-    *
-    * @return true if workbook has macros, false if not
-    */
+     * The workbook has macros ?
+     *
+     * @return true if workbook has macros, false if not
+     */
     public function hasMacros()
     {
         return $this->hasMacros;
     }
 
     /**
-    * Define if a workbook has macros
-    *
-    * @param boolean $hasMacros true|false
-    */
+     * Define if a workbook has macros
+     *
+     * @param boolean $hasMacros true|false
+     */
     public function setHasMacros($hasMacros = false)
     {
         $this->hasMacros = (bool) $hasMacros;
     }
 
     /**
-    * Set the macros code
-    *
-    * @param string $macroCode string|null
-    */
+     * Set the macros code
+     *
+     * @param string $macroCode string|null
+     */
     public function setMacrosCode($macroCode = null)
     {
         $this->macrosCode = $macroCode;
@@ -165,49 +165,49 @@ 
     }
 
     /**
-    * Return the macros code
-    *
-    * @return string|null
-    */
+     * Return the macros code
+     *
+     * @return string|null
+     */
     public function getMacrosCode()
     {
         return $this->macrosCode;
     }
 
     /**
-    * Set the macros certificate
-    *
-    * @param string|null $Certificate
-    */
+     * Set the macros certificate
+     *
+     * @param string|null $Certificate
+     */
     public function setMacrosCertificate($certificate = null)
     {
         $this->macrosCertificate = $certificate;
     }
 
     /**
-    * Is the project signed ?
-    *
-    * @return boolean true|false
-    */
+     * Is the project signed ?
+     *
+     * @return boolean true|false
+     */
     public function hasMacrosCertificate()
     {
         return !is_null($this->macrosCertificate);
     }
 
     /**
-    * Return the macros certificate
-    *
-    * @return string|null
-    */
+     * Return the macros certificate
+     *
+     * @return string|null
+     */
     public function getMacrosCertificate()
     {
         return $this->macrosCertificate;
     }
 
     /**
-    * Remove all macros, certificate from spreadsheet
-    *
-    */
+     * Remove all macros, certificate from spreadsheet
+     *
+     */
     public function discardMacros()
     {
         $this->hasMacros = false;
@@ -216,9 +216,9 @@ 
     }
 
     /**
-    * set ribbon XML data
-    *
-    */
+     * set ribbon XML data
+     *
+     */
     public function setRibbonXMLData($target = null, $xmlData = null)
     {
         if (!is_null($target) && !is_null($xmlData)) {
@@ -229,10 +229,10 @@ 
     }
 
     /**
-    * retrieve ribbon XML Data
-    *
-    * return string|null|array
-    */
+     * retrieve ribbon XML Data
+     *
+     * return string|null|array
+     */
     public function getRibbonXMLData($what = 'all') //we need some constants here...
     {
         $returnData = null;
@@ -253,9 +253,9 @@ 
     }
 
     /**
-    * store binaries ribbon objects (pictures)
-    *
-    */
+     * store binaries ribbon objects (pictures)
+     *
+     */
     public function setRibbonBinObjects($BinObjectsNames = null, $BinObjectsData = null)
     {
         if (!is_null($BinObjectsNames) && !is_null($BinObjectsData)) {
@@ -265,18 +265,18 @@ 
         }
     }
     /**
-    * return the extension of a filename. Internal use for a array_map callback (php<5.3 don't like lambda function)
-    *
-    */
+     * return the extension of a filename. Internal use for a array_map callback (php<5.3 don't like lambda function)
+     *
+     */
     private function getExtensionOnly($ThePath)
     {
         return pathinfo($ThePath, PATHINFO_EXTENSION);
     }
 
     /**
-    * retrieve Binaries Ribbon Objects
-    *
-    */
+     * retrieve Binaries Ribbon Objects
+     *
+     */
     public function getRibbonBinObjects($What = 'all')
     {
         $ReturnData = null;
@@ -305,20 +305,20 @@ 
     }
 
     /**
-    * This workbook have a custom UI ?
-    *
-    * @return true|false
-    */
+     * This workbook have a custom UI ?
+     *
+     * @return true|false
+     */
     public function hasRibbon()
     {
         return !is_null($this->ribbonXMLData);
     }
 
     /**
-    * This workbook have additionnal object for the ribbon ?
-    *
-    * @return true|false
-    */
+     * This workbook have additionnal object for the ribbon ?
+     *
+     * @return true|false
+     */
     public function hasRibbonBinObjects()
     {
         return !is_null($this->ribbonBinObjects);
@@ -353,9 +353,9 @@ 
         return null;
     }
 
-     /**
-     * Create a new PhpSpreadsheet with one Worksheet
-     */
+        /**
+         * Create a new PhpSpreadsheet with one Worksheet
+         */
     public function __construct()
     {
         $this->uniqueID = uniqid();

src/PhpSpreadsheet/Style.php

Doc Comments +1 added lines, -1 removed lines

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