enwikipedia-acc / waca

includes/Background/BackgroundTaskBase.php

Doc Comments +3 added lines

@@ -233,6 +233,9 @@
         Logger::backgroundJobComplete($this->getDatabase(), $this->getJob());
     }
 
+    /**
+     * @param string $reason
+     */
     protected function markCancelled($reason = null)
     {
         $this->job->setStatus(JobQueue::STATUS_CANCELLED);

includes/Background/CreationTaskBase.php

Doc Comments +4 added lines, -1 removed lines

@@ -105,6 +105,9 @@ 
         return $this->getMediaWikiHelper()->checkAccountExists($name);
     }
 
+    /**
+     * @param string $reason
+     */
     protected function markFailed($reason = null)
     {
         $this->request->setStatus(RequestStatus::HOSPITAL);
@@ -116,7 +119,7 @@ 
     }
 
     /**
-     * @param $user
+     * @param User $user
      *
      * @throws ApplicationLogicException
      */

includes/DataObjects/JobQueue.php

Doc Comments +1 added lines, -1 removed lines

@@ -225,7 +225,7 @@
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getError()
     {

includes/DataObjects/OAuthIdentity.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -10,9 +10,9 @@
 
 use DateTimeImmutable;
 use Exception;
-use stdClass;
 use Waca\DataObject;
 use Waca\Exceptions\OptimisticLockFailedException;
+use stdClass;
 
 class OAuthIdentity extends DataObject
 {

includes/DataObjects/OAuthToken.php

Doc Comments +5 added lines, -5 removed lines

@@ -83,7 +83,7 @@ 
     #region properties
 
     /**
-     * @return mixed
+     * @return integer
      */
     public function getUserId()
     {
@@ -99,7 +99,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getToken()
     {
@@ -115,7 +115,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getSecret()
     {
@@ -131,7 +131,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getType()
     {
@@ -139,7 +139,7 @@ 
     }
 
     /**
-     * @param mixed $type
+     * @param string $type
      */
     public function setType($type)
     {

includes/Helpers/BotMediaWikiClient.php

Doc Comments +1 added lines, -1 removed lines

@@ -83,7 +83,7 @@
 
     /**
      * @param $apiParams
-     * @param $method
+     * @param string $method
      *
      * @return mixed
      * @throws ApplicationLogicException

includes/Helpers/Interfaces/IMediaWikiClient.php

Doc Comments +3 added lines

@@ -10,5 +10,8 @@
 
 interface IMediaWikiClient
 {
+    /**
+     * @param string $method
+     */
     function doApiCall($params, $method);
 }
\ No newline at end of file

includes/Helpers/OAuthUserHelper.php

Doc Comments +13 added lines, -1 removed lines

@@ -63,6 +63,10 @@ 
     private $siteConfiguration;
 
     #region Static methods
+
+    /**
+     * @param null|string $requestToken
+     */
     public static function findUserByRequestToken($requestToken, PdoDatabase $database)
     {
         $statement = $database->prepare(<<<'SQL'
@@ -119,6 +123,11 @@ 
         }
     }
 
+    /**
+     * @param integer $userId
+     * @param null|PdoDatabase $database
+     * @param string $tokenType
+     */
     private static function runTokenCount($userId, $database, $tokenType)
     {
         if (self::$tokenCountStatement === null) {
@@ -182,7 +191,7 @@ 
     /**
      * Attempts to figure out if a user is partially linked to OAuth, and therefore needs to complete the OAuth
      * procedure before configuring.
-     * @return bool
+     * @return boolean|null
      */
     public function isPartiallyLinked()
     {
@@ -245,6 +254,9 @@ 
         return $this->oauthProtocolHelper->getAuthoriseUrl($token->key);
     }
 
+    /**
+     * @param null|string $verificationToken
+     */
     public function completeHandshake($verificationToken)
     {
         $this->getTokenStatement->execute(array(':user' => $this->user->getId(), ':type' => self::TOKEN_REQUEST));

includes/Pages/PageJobQueue.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -14,8 +14,8 @@
 use Waca\DataObjects\Request;
 use Waca\DataObjects\User;
 use Waca\Exceptions\ApplicationLogicException;
-use Waca\Helpers\Logger;
 use Waca\Helpers\LogHelper;
+use Waca\Helpers\Logger;
 use Waca\Helpers\SearchHelpers\JobQueueSearchHelper;
 use Waca\Helpers\SearchHelpers\LogSearchHelper;
 use Waca\Helpers\SearchHelpers\RequestSearchHelper;