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

Braces +1 added lines, -1 removed lines

@@ -177,7 +177,7 @@
             throw new ApplicationLogicException('Cannot locate request');
         }
 
-        if($this->job->getEmailTemplate() !== null){
+        if($this->job->getEmailTemplate() !== null) {
             $this->emailTemplate = EmailTemplate::getById($this->job->getEmailTemplate(), $this->getDatabase());
 
             if ($this->emailTemplate === false) {

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
      */

Braces +2 added lines, -1 removed lines

@@ -82,7 +82,8 @@
      */
     protected abstract function getMediaWikiClient();
 
-    protected function getMediaWikiHelper(){
+    protected function getMediaWikiHelper()
+    {
         if($this->mwHelper === null) {
             $this->mwHelper = new MediaWikiHelper($this->getMediaWikiClient(), $this->getSiteConfiguration());
         }

includes/DataObjects/JobQueue.php

Doc Comments +1 added lines, -1 removed lines

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

Braces +2 added lines, -1 removed lines

@@ -58,7 +58,8 @@
     /**
      * This feels like the least bad place to put this method.
      */
-    public static function getTaskDescriptions() {
+    public static function getTaskDescriptions()
+    {
         return array(
             BotCreationTask::class  => 'Create account (via bot)',
             UserCreationTask::class => 'Create account (via OAuth)',

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

Braces +1 added lines, -1 removed lines

@@ -142,7 +142,7 @@
 
         $loginResponse = $this->callApi($params, 'POST');
 
-        if($loginResponse->login->result == 'Success'){
+        if($loginResponse->login->result == 'Success') {
             return;
         }
 

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/Helpers/MediaWikiHelper.php

Braces +2 added lines, -1 removed lines

@@ -241,7 +241,8 @@
      * @param string $username
      * @return bool
      */
-    public function checkAccountExists($username) {
+    public function checkAccountExists($username)
+    {
         $parameters = array(
             'action'  => 'query',
             'list'    => 'users',

includes/Helpers/SearchHelpers/JobQueueSearchHelper.php

Braces +12 added lines, -6 removed lines

@@ -23,7 +23,8 @@ 
      *
      * @return JobQueueSearchHelper
      */
-    public static function get(PdoDatabase $database) {
+    public static function get(PdoDatabase $database)
+    {
         $helper = new JobQueueSearchHelper($database);
         return $helper;
     }
@@ -33,7 +34,8 @@ 
      *
      * @return $this
      */
-    public function statusIn($statuses) {
+    public function statusIn($statuses)
+    {
         $this->inClause('status', $statuses);
 
         return $this;
@@ -42,27 +44,31 @@ 
     /**
      * @return $this
      */
-    public function notAcknowledged() {
+    public function notAcknowledged()
+    {
         $this->whereClause .= ' AND (acknowledged IS NULL OR acknowledged = 0)';
 
         return $this;
     }
 
-    public function byTask($task) {
+    public function byTask($task)
+    {
         $this->whereClause .= ' AND task = ?';
         $this->parameterList[] = $task;
 
         return $this;
     }
 
-    public function byUser($userId) {
+    public function byUser($userId)
+    {
         $this->whereClause .= ' AND user = ?';
         $this->parameterList[] = $userId;
 
         return $this;
     }
 
-    public function byStatus($status) {
+    public function byStatus($status)
+    {
         $this->whereClause .= ' AND status = ?';
         $this->parameterList[] = $status;