symball / report

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 string|integer $key
+     * @param string $key
      * @return array
      * @throws \Exception
      */
@@ -299,7 +299,7 @@ 
     /**
      * Return a specific piece of data from the current data point
      *
-     * @param string|integer $key
+     * @param string $key
      * @return mixed
      */
     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 string|integer $defaultValue The default also defines type of column
-   * @param array  $options      Additional parameters for the column to use
-   *
-   * @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 string|integer $defaultValue The default also defines type of column
+     * @param array  $options      Additional parameters for the column to use
+     *
+     * @return $this
+     */
     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 array $inputData A set of data which conforms to the column specification
-   * @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 array $inputData A set of data which conforms to the column specification
+     * @return $this
+     */
     public function setData($inputData)
     {
         // Combine raw data with the meta data