Maelstromeous / ps2alerts-api

src/Controller/Statistics/OutfitTotalsStatisticsEndpoint.php

Doc Comments +1 added lines, -2 removed lines

@@ -12,7 +12,7 @@ 
     /**
      * Construct
      *
-     * @param \Ps2alerts\Api\Loader\Metrics\OutfitTotalsStatisticsLoader $loader
+     * @param OutfitTotalsStatisticsLoader $loader
      */
     public function __construct(OutfitTotalsStatisticsLoader $loader)
     {
@@ -23,7 +23,6 @@ 
      * Returns top X entries
      *
      * @param  \Symfony\Component\HttpFoundation\Request $request
-     * @param  array                                     $args
      *
      * @return \League\Route\Http\JsonResponse
      */

src/Controller/Statistics/PlayerStatisticsEndpoint.php

Doc Comments +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
     /**
      * Construct
      *
-     * @param \Ps2alerts\Api\Loader\Metrics\PlayerStatisticsLoader $loader
+     * @param PlayerStatisticsLoader $loader
      */
     public function __construct(PlayerStatisticsLoader $loader)
     {

src/Loader/AbstractLoader.php

Doc Comments +2 added lines, -3 removed lines

@@ -77,7 +77,6 @@ 
     /**
      * Gets the Cache namespace key for Redis
      *
-     * @param string $string
      */
     public function getCacheNamespace()
     {
@@ -128,7 +127,7 @@ 
      * Checks for a key within Redis and returns it's existance
      *
      * @param  string  $key
-     * @return boolean
+     * @return false|null
      */
     public function checkRedis($key)
     {
@@ -155,7 +154,7 @@ 
      * Sets JSON encoded value within Redis with an expiry in seconds
      *
      * @param string  $key
-     * @param mixed   $value   Data to encode into JSON and store
+     * @param string   $value   Data to encode into JSON and store
      * @param integer $expires Cache expiry time in seconds
      */
     public function setExpireKey($key, $value, $expires)

src/Loader/Statistics/PlayerStatisticsLoader.php

Doc Comments +3 added lines

@@ -91,6 +91,9 @@
         );
     }
 
+    /**
+     * @param string $field
+     */
     public function validatePostVars($field, $value)
     {
         if ($field === 'metric' && ! empty($value)) {

src/QueryObjects/QueryObject.php

Doc Comments +2 added lines, -2 removed lines

@@ -49,7 +49,7 @@ 
      * in the array and added to.
      * e.g. $queryObject->addSelect('COUNT(ResultID) AS COUNT');
      *
-     * @param string $string
+     * @param string $array
      */
     public function addSelect($array)
     {
@@ -171,7 +171,7 @@ 
     /**
      * Allows setting of workaround flags
      *
-     * @param array|string $flags
+     * @param string $flags
      */
     public function setFlags($flags)
     {