BurningFlipside / CommonCode

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

Data/class.FilterClause.php

Doc Comments +9 added lines

@@ -28,12 +28,18 @@ 
         return substr($haystack, 0, strlen($needle)) === $needle;
     }
 
+    /**
+     * @param string $string
+     */
     protected function filterIsFunction($string)
     {
         return (self::str_startswith($string, 'substringof') || self::str_startswith($string, 'contains') ||
                 self::str_startswith($string, 'indexof'));
     }
 
+    /**
+     * @param string $op
+     */
     protected function odataOpToStd($op)
     {
         switch($op)
@@ -146,6 +152,9 @@ 
         }
     }
 
+    /**
+     * @param string $op
+     */
     private function getMongoClauseArray($op, $var2)
     {
         return array($this->opToMongo($op)=>$var2);

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

Auth/class.SQLAuthenticator.php

Doc Comments +11 added lines, -1 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()
     {
@@ -189,6 +189,10 @@ 
         return new SQLUser($data, $this);
     }
 
+    /**
+     * @param string $tableName
+     * @param string $className
+     */
     private function getEntityByFilter($tableName, $filterStr, $className)
     {
         $dataTable = $this->getDataTable($tableName);
@@ -211,6 +215,9 @@ 
         return $this->getEntityByFilter('user', "uid eq '$name'", '\Auth\SQLUser');
     }
 
+    /**
+     * @param string $dataTableName
+     */
     private function getDataByFilter($dataTableName, $filter, $select, $top, $skip, $orderby)
     {
         $dataTable = $this->getDataTable($dataTableName);
@@ -276,6 +283,9 @@ 
         return $dataTable->count();
     }
 
+    /**
+     * @param \Data\Filter $filter
+     */
     private function searchPendingUsers($filter, $select, $top, $skip, $orderby)
     {
         $userDataTable = $this->getPendingUserDataTable();

Data/class.SQLDataSet.php

Doc Comments +14 added lines, -1 removed lines

@@ -116,6 +116,10 @@ 
         return $sql;
     }
 
+    /**
+     * @param boolean|string $count
+     * @param boolean|string $skip
+     */
     private function getLimitClause($count, $skip)
     {
         if($count === false)
@@ -139,7 +143,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
      */
@@ -177,6 +181,9 @@ 
         return $ret;
     }
 
+    /**
+     * @param string $tablename
+     */
     public function update($tablename, $where, $data)
     {
         $set = array();
@@ -199,6 +206,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $tablename
+     */
     public function create($tablename, $data)
     {
         $set = array();
@@ -222,6 +232,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $tablename
+     */
     public function delete($tablename, $where)
     {
         $sql = "DELETE FROM $tablename WHERE $where";

class.FlipREST.php

Spacing +2 added lines, -2 removed lines

@@ -179,7 +179,7 @@ 
 
     private function create_excel(&$array)
     {
-        require_once dirname(__FILE__) . '/libs/PHPExcel/Classes/PHPExcel.php';
+        require_once dirname(__FILE__).'/libs/PHPExcel/Classes/PHPExcel.php';
         $ssheat = new PHPExcel();
         $sheat = $ssheat->setActiveSheetIndex(0);
         if(is_array($array))
@@ -228,7 +228,7 @@ 
                         {
                             $value = implode(',', $value);
                         }
-                        $sheat->setCellValueByColumnAndRow($j, 2+$i, $value);
+                        $sheat->setCellValueByColumnAndRow($j, 2 + $i, $value);
                     }
                 }
             }

Auth/class.LDAPCachableObject.php

Doc Comments +4 added lines, -1 removed lines

@@ -22,6 +22,9 @@ 
         $this->ldapObj = $this->initializeFromArray($data);
     }
 
+    /**
+     * @param string $dn
+     */
     private function initializeFromDN($dn)
     {
         $data = $this->server->read($dn, false, true);
@@ -88,7 +91,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)
     {

Email/class.SMTPServer.php

Spacing +2 added lines, -2 removed lines

@@ -59,8 +59,8 @@
             return array($address);
         }
         $ret = array();
-        $ret[0] = trim(substr($address, $pos+1), '>');
-        $ret[1] = substr($address, 0, $pos-1);
+        $ret[0] = trim(substr($address, $pos + 1), '>');
+        $ret[1] = substr($address, 0, $pos - 1);
         return $ret;
     }
 

class.FlipsideCAPTCHA.php

Doc Comments +6 added lines

@@ -104,6 +104,9 @@ 
         $this->random_id = $this->validIDs[$this->random_id];
     }
 
+    /**
+     * @param string $fieldName
+     */
     protected function getCaptchField($fieldName)
     {
         $dataset = DataSetFactory::getDataSetByName('profiles');
@@ -126,6 +129,9 @@ 
         return $this->getCaptchField('hint');
     }
 
+    /**
+     * @return string
+     */
     private function get_answer()
     {
         return $this->getCaptchField('answer');