BurningFlipside / CommonCode

cron.php

Spacing +2 added lines, -2 removed lines

@@ -14,8 +14,8 @@
 /**
  * This cron script recompiles the Browscap cache
  */
-ini_set('memory_limit','-1');      // turn off memory limit for this script
-set_time_limit(120);               // change to 2 minutes for this script
+ini_set('memory_limit', '-1'); // turn off memory limit for this script
+set_time_limit(120); // change to 2 minutes for this script
 
 require('vendor/autoload.php');
 

Auth/LDAPCachableObject.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
      *
      * @param string $fieldName The name of the field to retrieve
      *
-     * @return mixed string the value of the field
+     * @return string string the value of the field
      */
     protected function getFieldSingleValue($fieldName)
     {

Auth/SQLAuthenticator.php

Doc Comments +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
     /**
      * Get the data table for Pending Users
      *
-     * @return boolean|\Data\DataTable The Pending User Data Table
+     * @return boolean The Pending User Data Table
      */
     private function getPendingUserDataTable()
     {

Auth/User.php

Doc Comments +1 added lines, -1 removed lines

@@ -311,7 +311,7 @@
      *
      * @param stdClass $data The user's new data
      *
-     * @return boolean true if the user's data was changed, false otherwise
+     * @return boolean|null true if the user's data was changed, false otherwise
      */
     public function editUser($data)
     {

AuthProvider.php

Doc Comments +4 added lines, -4 removed lines

@@ -253,10 +253,10 @@
      * Get an array of Auth\PendingUser from a filtered set
      *
      * @param Data\Filter|boolean $filter The filter conditions or false to retreive all
-     * @param array|boolean $select The user fields to obtain or false to obtain all
-     * @param integer|boolean $top The number of users to obtain or false to obtain all
-     * @param integer|boolean $skip The number of users to skip or false to skip none
-     * @param array|boolean $orderby The field to sort by and the method to sort or false to not sort
+     * @param boolean $select The user fields to obtain or false to obtain all
+     * @param boolean $top The number of users to obtain or false to obtain all
+     * @param boolean $skip The number of users to skip or false to skip none
+     * @param boolean $orderby The field to sort by and the method to sort or false to not sort
      * @param string|boolean $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator
      *
      * @return array|boolean An array of Auth\PendingUser objects or false if no pending users were found

Spacing +1 added lines, -1 removed lines

@@ -78,7 +78,7 @@
             {
                 if(isset($res['extended']) && isset($res['extended']['jpegphoto']))
                 {
-                    $res['extended']['jpegphoto']=true;
+                    $res['extended']['jpegphoto'] = true;
                 }
                 FlipSession::setVar('AuthMethod', get_class($this->methods[$i]));
                 FlipSession::setVar('AuthData', $res);

Data/FilterClause.php

Doc Comments +1 added lines, -1 removed lines

@@ -176,7 +176,7 @@
      * Convert the right hand side of the filter clause into an Mongo array
      *
      * @param string $op The standard operator
-     * @param string $var The second variable in the operator
+     * @param string $var2 The second variable in the operator
      *
      * @return array An array of mongo operations
      */

Data/SQLDataSet.php

Doc Comments +1 added lines, -1 removed lines

@@ -150,7 +150,7 @@
      * @param string $select The colums to read
      * @param boolean|string $count The number of rows to read
      * @param boolean|string $skip The number of rows to skip over
-     * @param boolean|array $sort The array to sort by or false to not sort
+     * @param boolean $sort The array to sort by or false to not sort
      *
      * @return false|array An array of all the returned records
      */

Spacing +2 added lines, -2 removed lines

@@ -247,7 +247,7 @@ 
         $stmt = $this->pdo->query($sql);
         if($stmt === false)
         {
-            if (php_sapi_name() !== "cli") {
+            if(php_sapi_name() !== "cli") {
               error_log('DB query failed. '.print_r($this->pdo->errorInfo(), true));
             }
             return false;
@@ -296,7 +296,7 @@ 
         $sql = "INSERT INTO $tablename ($cols) VALUES ($set);";
         if($this->pdo->exec($sql) === false)
         {
-            if (php_sapi_name() !== "cli") {
+            if(php_sapi_name() !== "cli") {
                 error_log('DB query failed. '.print_r($this->pdo->errorInfo(), true));
             }
             return false;

Email/DBEmail.php

Doc Comments +8 added lines

@@ -44,8 +44,16 @@
         return parent::getSubject();
     }
 
+    /**
+     * @return string
+     */
     public abstract function getSubstituteVars();
 
+    /**
+     * @param boolean $html
+     *
+     * @return string
+     */
     protected function getRawBodyText($html)
     {
         if(isset($this->dbData['body']))

Spacing +4 added lines, -4 removed lines

@@ -21,7 +21,7 @@ 
     {
         if(isset($this->dbData['from']))
         {
-            return $this->dbData['from'];;
+            return $this->dbData['from']; ;
         }
         return parent::getFromAddress();
     }
@@ -30,7 +30,7 @@ 
     {
         if(isset($this->dbData['replyTo']))
         {
-            return $this->dbData['replyTo'];;
+            return $this->dbData['replyTo']; ;
         }
         return parent::getReplyTo();
     }
@@ -59,7 +59,7 @@ 
         return $this->textBody;
     }
 
-    protected function getBodyFromDB($html=true)
+    protected function getBodyFromDB($html = true)
     {
         $vars = $this->getSubstituteVars();
         $rawText = $this->getRawBodyText($html);
@@ -74,7 +74,7 @@ 
             $end = strpos($rawText, "</script>");
             if($index === 0)
             {
-                $rawText = substr($rawText, $end+9);
+                $rawText = substr($rawText, $end + 9);
             }
         }
         return strtr(strip_tags($rawText), $vars);

FlipsideCAPTCHA.php

Doc Comments +6 added lines

@@ -108,6 +108,9 @@ 
         $this->wwwUrl = $settings->getGlobalSetting('www_url', 'https://www.burningflipside.com');
     }
 
+    /**
+     * @param string $fieldName
+     */
     protected function getCaptchField($fieldName)
     {
         $dataset = DataSetFactory::getDataSetByName('profiles');
@@ -130,6 +133,9 @@ 
         return $this->getCaptchField('hint');
     }
 
+    /**
+     * @return string
+     */
     private function get_answer()
     {
         return $this->getCaptchField('answer');