BurningFlipside / CommonCode

Auth/class.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)
     {

class.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

LDAP/class.LDAPServer.php

Doc Comments -1 removed lines

@@ -6,7 +6,6 @@
  * @author Chris Wright
  * @version 2.0
  * @param string $subject The subject string
- * @param bool $dn Treat subject as a DN if TRUE
  * @param string|array $ignore Set of characters to leave untouched
  * @return string The escaped string
  */

Serialize/class.ExcelSerializer.php

Doc Comments +3 added lines

@@ -7,6 +7,9 @@
 {
     protected $types = array('xlsx', 'xls', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/vnd.ms-excel');
 
+    /**
+     * @param integer $row
+     */
     protected function setRowFromArray(&$sheat, $row, $array, $count = 0)
     {
         if($count === 0)

Data/class.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;
         }

Auth/class.SQLAuthenticator.php

Doc Comments +2 added lines, -2 removed lines

@@ -140,7 +140,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()
     {
@@ -300,7 +300,7 @@ 
     /**
      * Search all the pending users
      *
-     * @param boolean|\Data\Filter $filter The filter to use while searching the table
+     * @param \Data\Filter $filter The filter to use while searching the table
      * @param boolean|array $select The array of properties to read
      * @param boolean|integer $top The number of records to read
      * @param boolean|integer $skip The number of records to skip

Data/class.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 +4 added lines, -4 removed lines

@@ -222,15 +222,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;

Auth/class.LDAPAuthenticator.php

Doc Comments +1 added lines, -1 removed lines

@@ -329,7 +329,7 @@
     }
 
     /**
-     * @param boolean|\Data\Filter $filter The filter to user when reading users
+     * @param \Data\Filter $filter The filter to user when reading users
      * @param boolean|array   $select The fields to return
      * @param boolean|integer $top The number of records to return
      * @param boolean|integer $skip The number of records to skip

Email/class.DBEmail.php

Doc Comments +6 added lines

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