BurningFlipside / CommonCode

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

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

Indentation +14 added lines, -14 removed lines

@@ -140,9 +140,9 @@ 
             $case = true;
         }
         if($case)
-	{
+    {
             if(class_exists('MongoRegex'))
-	    {
+        {
                 return array($field=>array('$regex'=>new \MongoRegex('/'.$this->var2.'/i')));
             }
             else
@@ -236,15 +236,15 @@ 
         {
             case '=':
                 return array($this->var1=>$this->var2);
-	    case 'substringof':
-		if(class_exists('MongoRegex'))
-		{
-		    return array($this->var1=>array('$regex'=>new \MongoRegex('/'.$this->var2.'/i')));
-		}
-		else
-		{
+        case 'substringof':
+        if(class_exists('MongoRegex'))
+        {
+            return array($this->var1=>array('$regex'=>new \MongoRegex('/'.$this->var2.'/i')));
+        }
+        else
+        {
                     return array($this->var1=>array('$regex'=>new \MongoDB\BSON\Regex($this->var2, 'i')));
-		}
+        }
             case 'indexof':
                 return $this->getMongoIndexOfOperator();
             default:
@@ -254,15 +254,15 @@ 
 
     public function php_compare($value)
     {
-	if(is_array($value))
-	{
+    if(is_array($value))
+    {
             return $this->php_compare($value[$this->var1]);
-	}
+    }
         switch($this->op)
         {
             case '!=':
                 return $value != $this->var2;
-	    case '=':
+        case '=':
                 return $value == $this->var2;
             case '<':
                 return $value < $this->var2;

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

Indentation +1 added lines, -1 removed lines

@@ -248,7 +248,7 @@
         if($stmt === false)
         {
             if (php_sapi_name() !== "cli") {
-              error_log('DB query failed. '.print_r($this->pdo->errorInfo(), true));
+                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']))

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

Http/FlipAdminPage.php

Doc Comments +3 added lines

@@ -11,6 +11,9 @@
         $this->setTemplateName('admin.html');
     }
 
+    /**
+     * @param string $adminGroup
+     */
     protected function userIsAdmin($adminGroup)
     {
         if($this->user === false || $this->user === null)

Indentation +4 added lines, -4 removed lines

@@ -49,7 +49,7 @@ 
         $this->addLink('Home', '..');
         if($this->user === false || $this->user === null)
         {
-          $this->content['body'] = '
+            $this->content['body'] = '
             <div id="content">
               <div class="row">
                 <div class="col-lg-12">
@@ -61,7 +61,7 @@ 
         }
         else if($this->isAdmin() === false)
         {
-          $this->content['body'] = '
+            $this->content['body'] = '
             <div id="content">
               <div class="row">
                 <div class="col-lg-12">
@@ -70,8 +70,8 @@ 
               </div>
             </div>
           ';
-          $this->content['header'] = array();
-          $this->content['cards'] = array();
+            $this->content['header'] = array();
+            $this->content['cards'] = array();
         }
         return parent::getContent();
     }

Http/Rest/DataTableAPI.php

Doc Comments +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
     /**
      * Create the DataTableAPI for the given DataTable info
      *
-     * @param string $datSetName The name of the DataSet used in the Settings
+     * @param string $dataSetName The name of the DataSet used in the Settings
      * @param string $dataTableName The name of the table in the DataSet
      * @param string|false $primaryKeyName The table primary key. Must be specified for update/delete capable tables
      */

Indentation +2 added lines, -2 removed lines

@@ -108,7 +108,7 @@ 
         $odata = $request->getAttribute('odata', new \Flipside\ODataParams(array()));
         $params = $this->manipulateParameters($request, $odata);
         $areas = $dataTable->read($odata->filter, $odata->select, $odata->top,
-                                  $odata->skip, $odata->orderby, $params);
+                                    $odata->skip, $odata->orderby, $params);
         if($areas === false)
         {
             $areas = array();
@@ -159,7 +159,7 @@ 
         $odata = $request->getAttribute('odata', new \Flipside\ODataParams(array()));
         $filter = $this->getFilterForPrimaryKey($args['name']);
         $areas = $dataTable->read($filter, $odata->select, $odata->top,
-                                  $odata->skip, $odata->orderby);
+                                    $odata->skip, $odata->orderby);
         if(empty($areas))
         {
             return $response->withStatus(404);