symball / report

Service/Excel.php

Doc Comments +3 added lines, -3 removed lines

@@ -193,7 +193,7 @@ 
     }
 
     /**
-     * @return object
+     * @return \PHPExcel
      */
     public function getExcelObject()
     {
@@ -221,7 +221,7 @@ 
      * is able to export
      *
      * @param string $format
-     * @return boolean
+     * @return boolean|null
      */
     public function checkOutputFormat($format)
     {
@@ -241,7 +241,7 @@ 
     }
 
     /**
-     * @param type $title
+     * @param string $title
      */
     protected function setCurrentSheetTitle($title)
     {

Indentation +14 added lines, -14 removed lines

@@ -64,14 +64,14 @@ 
     }
 
     /**
-   * Create a new sheet within the excel object and ready the service for it.
-   * This in essence resets most things so make sure you have finished working
-   * on your sheet before creating another.
-   *
-   * @param string $title The name of the sheet
-   *
-   * @return [type] [description]
-   */
+     * Create a new sheet within the excel object and ready the service for it.
+     * This in essence resets most things so make sure you have finished working
+     * on your sheet before creating another.
+     *
+     * @param string $title The name of the sheet
+     *
+     * @return [type] [description]
+     */
     public function newSheet($title = '')
     {
         if (!$this->excelObject) {
@@ -158,12 +158,12 @@ 
         $this->reportPath = $path;
     }
 
-  /**
-   * Set the "excel type" that will PHPExcel will output
-   * Excel2007 / Excel5 / Excel2003XML / SYLK / OOCalc / CSV / HTML.
-   *
-   * @param string $format [description]
-   */
+    /**
+     * Set the "excel type" that will PHPExcel will output
+     * Excel2007 / Excel5 / Excel2003XML / SYLK / OOCalc / CSV / HTML.
+     *
+     * @param string $format [description]
+     */
     public function setOutputFormat($format)
     {
 

Service/Meta.php

Doc Comments +5 added lines, -5 removed lines

@@ -37,7 +37,7 @@ 
      * Define an option and its value.
      *
      * @param string $key
-     * @param mixed  $value
+     * @param string  $value
      * @return $this For method chaining
      * @throws \InvalidArgumentException if key type is not a string or integer
      */
@@ -73,7 +73,7 @@ 
     /**
      * Get the value of a single option or return false if it doesn't exist
      *
-     * @param string|integer $key
+     * @param string $key
      * @return string|integer|boolean The option value
      */
     public function getOption($key)
@@ -143,7 +143,7 @@ 
    * data object.
    *
    * @param string         $key   The index to use
-   * @param string|integer $value The value to set
+   * @param string $value The value to set
    * @return $this
    * @throws \Exception
    */
@@ -268,7 +268,7 @@ 
     /**
      * Return the information array relating to a specific column
      *
-     * @param type $key
+     * @param string $key
      * @return array
      * @throws \Exception
      */
@@ -299,7 +299,7 @@ 
     /**
      * Return a specific piece of data from the current data point
      *
-     * @param type $key
+     * @param string $key
      * @return type
      */
     public function getPointValue($key)

Indentation +56 added lines, -56 removed lines

@@ -106,15 +106,15 @@ 
         );
     }
 
-  /**
-   * Increment the value for a key that makes up part of the currently focused
-   * data object.
-   *
-   * @param string $key   The index to use
-   * @param int    $value The value to increment by
-   * @return $this
-   * @throws \Exception if there is no data point, column or invalid type
-   */
+    /**
+     * Increment the value for a key that makes up part of the currently focused
+     * data object.
+     *
+     * @param string $key   The index to use
+     * @param int    $value The value to increment by
+     * @return $this
+     * @throws \Exception if there is no data point, column or invalid type
+     */
     public function increment($key, $value = 1)
     {
         if (!$this->currentDataPoint) {
@@ -138,15 +138,15 @@ 
         return $this;
     }
 
-  /**
-   * Directly set the value for a key that makes up part of the currently focused
-   * data object.
-   *
-   * @param string         $key   The index to use
-   * @param string|integer $value The value to set
-   * @return $this
-   * @throws \Exception
-   */
+    /**
+     * Directly set the value for a key that makes up part of the currently focused
+     * data object.
+     *
+     * @param string         $key   The index to use
+     * @param string|integer $value The value to set
+     * @return $this
+     * @throws \Exception
+     */
     public function set($key, $value)
     {
         if (!$this->currentDataPoint) {
@@ -161,13 +161,13 @@ 
         return $this;
     }
 
-  /**
-   * Set a focus for the current data object for which data can be manipulated.
-   * If the key doesn't exist, it will be created using default column values.
-   *
-   * @param string $key The reference key to be used
-   * @return $this
-   */
+    /**
+     * Set a focus for the current data object for which data can be manipulated.
+     * If the key doesn't exist, it will be created using default column values.
+     *
+     * @param string $key The reference key to be used
+     * @return $this
+     */
     public function setPoint($key)
     {
         if (!isset($this->currentDataSet[$key])) {
@@ -178,14 +178,14 @@ 
         return $this;
     }
 
-  /**
-   * Add a data point which will be shown on the report. This function should be
-   * used prior to any kind of data manipulation as it will not setup a data
-   * structure for manipulation.
-   *
-   * @param string $key The index to use
-   * @return $this
-   */
+    /**
+     * Add a data point which will be shown on the report. This function should be
+     * used prior to any kind of data manipulation as it will not setup a data
+     * structure for manipulation.
+     *
+     * @param string $key The index to use
+     * @return $this
+     */
     public function addPoint($key)
     {
         if (!in_array($key, $this->dataPoints)) {
@@ -196,20 +196,20 @@ 
         return $this;
     }
 
-  /**
-   * Define a type of data that will be presented on the report or metadata that
-   * will be used for calculations. In the latter case, within the options array
-   * set "visible" to false.
-   * At a minimum, the key needs to be set. In this case, the type will be string
-   * and the key converted in to a title
-   * .
-   *
-   * @param string $key          A reference key for the piece of data
-   * @param [type] $defaultValue The default also defines type of column
-   * @param array  $options      Additional parameters for the column to use
-   *
-   * @return [type] [description]
-   */
+    /**
+     * Define a type of data that will be presented on the report or metadata that
+     * will be used for calculations. In the latter case, within the options array
+     * set "visible" to false.
+     * At a minimum, the key needs to be set. In this case, the type will be string
+     * and the key converted in to a title
+     * .
+     *
+     * @param string $key          A reference key for the piece of data
+     * @param [type] $defaultValue The default also defines type of column
+     * @param array  $options      Additional parameters for the column to use
+     *
+     * @return [type] [description]
+     */
     public function column(
         $key,
         $defaultValue = '',
@@ -242,15 +242,15 @@ 
     }
 
     /**
-   * Manually set the data which will be used for the current set. when
-   * using this function, it will expect an associative array of arrays where
-   * each entry has a further array of values which have a key matching that of
-   * the meta data.
-   * TODO - This is quite messy, rewrite more efficiently.
-   *
-   * @param [type] $inputData [description]
-   * @return $this
-   */
+     * Manually set the data which will be used for the current set. when
+     * using this function, it will expect an associative array of arrays where
+     * each entry has a further array of values which have a key matching that of
+     * the meta data.
+     * TODO - This is quite messy, rewrite more efficiently.
+     *
+     * @param [type] $inputData [description]
+     * @return $this
+     */
     public function setData($inputData)
     {
         // Combine raw data with the meta data

Service/Nav.php

Doc Comments +1 added lines, -1 removed lines

@@ -278,7 +278,7 @@
      * @param string $input
      * @param string $axis
      *
-     * @return type
+     * @return integer
      */
     public function parseNavReference($input = '', $axis = 'column')
     {

Service/ReportBuilder.php

Doc Comments +2 added lines, -2 removed lines

@@ -199,7 +199,7 @@ 
     /**
      * Return the navigation service object
      *
-     * @return Nav
+     * @return NavInterface
      */
     public function nav()
     {
@@ -239,7 +239,7 @@ 
     /**
      * Return the data handling query service
      *
-     * @return Query
+     * @return QueryInterface
      */
     public function query()
     {

Unused Use Statements -1 removed lines

@@ -11,7 +11,6 @@
 
 namespace Symball\ReportBundle\Service;
 
-use Symball\ReportBundle\Service\ReportPattern;
 use Symball\ReportBundle\Service\ReportStyle;
 use Symball\ReportBundle\Service\Meta;
 use Symball\ReportBundle\Interfaces\NavInterface;

Tests/Unit/MetaTest.php

Unused Use Statements -1 removed lines

@@ -10,7 +10,6 @@
 
 /* The base PHPUnit test class */
 use PHPUnit\Framework\TestCase;
-
 use Symball\ReportBundle\Service\Meta;
 
 /* Extend the default PHPUnit test case */

Tests/Unit/ReportPatternTest.php

Unused Use Statements -1 removed lines

@@ -10,7 +10,6 @@
 
 /* The base PHPUnit test class */
 use PHPUnit\Framework\TestCase;
-
 use Symball\ReportBundle\Service\ReportPattern;
 use Symball\ReportBundle\Service\ReportBuilder;
 use Symball\ReportBundle\Interfaces\PatternInterface;

Spacing +2 added lines, -2 removed lines

@@ -43,7 +43,7 @@ 
         $mockPattern->method('run')->willReturn(true);
         $reportPattern->addPattern($mockPattern, 'an_alias');
 
-        $mockReportBuilder= $this->createMock(ReportBuilder::class);
+        $mockReportBuilder = $this->createMock(ReportBuilder::class);
 
         $result = $reportPattern->run('an_alias', $mockReportBuilder);
 
@@ -54,7 +54,7 @@ 
         $reportPattern = new ReportPattern();
 
         try {
-            $mockReportBuilder= $this->createMock(ReportBuilder::class);
+            $mockReportBuilder = $this->createMock(ReportBuilder::class);
             $result = $reportPattern->run('an_alias', $mockReportBuilder);
         } catch (\Exception $ex) {
             // General exception

Tests/Unit/ReportStyleTest.php

Unused Use Statements -1 removed lines

@@ -10,7 +10,6 @@
 
 /* The base PHPUnit test class */
 use PHPUnit\Framework\TestCase;
-
 use Symball\ReportBundle\Service\Meta;
 use Symball\ReportBundle\Service\ReportStyle;
 use Symball\ReportBundle\Service\ReportBuilder;

Spacing +2 added lines, -2 removed lines

@@ -47,7 +47,7 @@ 
         $mockMeta = $this->createMock(Meta::class);
         $mockMeta->method('getOptions')->willReturn([]);
 
-        $mockReportBuilder= $this->createMock(ReportBuilder::class);
+        $mockReportBuilder = $this->createMock(ReportBuilder::class);
         $mockReportBuilder->method('meta')->will($this->returnValue($mockMeta));
 
         $result = $reportStyle->run('an_alias', $mockReportBuilder, 'A1');
@@ -61,7 +61,7 @@ 
         $mockMeta = $this->createMock(Meta::class);
         $mockMeta->method('getOptions')->willReturn([]);
 
-        $mockReportBuilder= $this->createMock(ReportBuilder::class);
+        $mockReportBuilder = $this->createMock(ReportBuilder::class);
         $mockReportBuilder->method('meta')->will($this->returnValue($mockMeta));
 
         try {

Interfaces/StyleInterface.php

Spacing +1 added lines, -1 removed lines

@@ -22,5 +22,5 @@
      * @param string        $coordString
      * @param array         $options
      */
-    public function run(ReportBuilder &$context, $coordString, $options);
+    public function run(ReportBuilder&$context, $coordString, $options);
 }

Interfaces/PatternInterface.php

Spacing +1 added lines, -1 removed lines

@@ -20,5 +20,5 @@
      *
      * @param ReportBuilder $context
      */
-    public function run(ReportBuilder &$context);
+    public function run(ReportBuilder&$context);
 }