BurningFlipside / CommonCode

class.FlipsideCAPTCHA.php

Doc Comments +3 added lines

@@ -69,6 +69,9 @@
         return $data[0]['hint'];
     }
 
+    /**
+     * @return string
+     */
     private function get_answer()
     {
         $dataset = DataSetFactory::get_data_set('profiles');

Spacing +6 added lines, -6 removed lines

@@ -36,13 +36,13 @@ 
     {
         $dataset = DataSetFactory::getDataSetByName('profiles');
         $datatable = $dataset['captcha'];
-        return $datatable->create(array('question'=>$question,'hint'=>$hint,'answer'=>$answer));
+        return $datatable->create(array('question'=>$question, 'hint'=>$hint, 'answer'=>$answer));
     }
 
     public function __construct()
     {
         $this->validIDs = FlipsideCAPTCHA::get_valid_captcha_ids();
-        $this->random_id = mt_rand(0, count($this->validIDs)-1);
+        $this->random_id = mt_rand(0, count($this->validIDs) - 1);
         $this->random_id = $this->validIDs[$this->random_id];
     }
 
@@ -84,22 +84,22 @@ 
 
     public function is_answer_right($answer)
     {
-        return strcasecmp($this->get_answer(),$answer) == 0;
+        return strcasecmp($this->get_answer(), $answer) == 0;
     }
 
-    public function draw_captcha($explination=true, $return=false, $ownForm=false)
+    public function draw_captcha($explination = true, $return = false, $ownForm = false)
     {
         $string = '';
 
         if($ownForm)
         {
-            $string.= '<form id="flipcaptcha" name="flipcaptcha">';
+            $string .= '<form id="flipcaptcha" name="flipcaptcha">';
         }
 
         $string .= '<label for="captcha" class="col-sm-2 control-label">'.$this->get_question().'</label><div class="col-sm-10"><input class="form-control" type="text" id="captcha" name="captcha" placeholder="'.$this->get_hint().'" required/></div>';
         if($ownForm)
         {
-            $string.='</form>';
+            $string .= '</form>';
         }
         if($explination)
         {

class.SerializableObject.php

Doc Comments +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
     /**
      * Serialize the object into a format consumable by json_encode
      *
-     * @return mixed The object in a more serialized format
+     * @return SerializableObject The object in a more serialized format
      */
     public function jsonSerialize()
     {

Data/class.FilterClause.php

Doc Comments +6 added lines

@@ -12,11 +12,17 @@
         if($string !== false) $this->process_filter_string($string);
     }
 
+    /**
+     * @param string $needle
+     */
     static function str_startswith($haystack, $needle)
     {
         return substr($haystack, 0, strlen($needle)) === $needle;
     }
 
+    /**
+     * @param boolean $string
+     */
     protected function process_filter_string($string)
     {
         if(self::str_startswith($string, 'substringof') || self::str_startswith($string, 'contains') || 

Braces +4 added lines, -1 removed lines

@@ -9,7 +9,10 @@
 
     function __construct($string=false)
     {
-        if($string !== false) $this->process_filter_string($string);
+        if($string !== false)
+        {
+            $this->process_filter_string($string);
+        }
     }
 
     static function str_startswith($haystack, $needle)

Data/class.SQLDataSet.php

Doc Comments +3 added lines

@@ -17,6 +17,9 @@
         }
     }
 
+    /**
+     * @param string $sql
+     */
     function _get_row_count_for_query($sql)
     {
         $stmt = $this->pdo->query($sql);

Spacing +2 added lines, -2 removed lines

@@ -134,9 +134,9 @@
             $tmp = array();
             foreach($sort as $sort_col=>$dir)
             {
-                array_push($tmp, $sort_col.' '.($dir === 1? 'ASC' : 'DESC'));
+                array_push($tmp, $sort_col.' '.($dir === 1 ? 'ASC' : 'DESC'));
             }
-            $sql .= implode($tmp,',');
+            $sql .= implode($tmp, ',');
         }
         $stmt = $this->pdo->query($sql, \PDO::FETCH_ASSOC);
         if($stmt === false)

Data/class.SQLDataTable.php

Doc Comments +3 added lines

@@ -6,6 +6,9 @@
     protected $dataset;
     protected $tablename;
 
+    /**
+     * @param SQLDataSet $dataset
+     */
     function __construct($dataset, $tablename)
     {
         $this->dataset   = $dataset;

Indentation +4 added lines, -4 removed lines

@@ -65,11 +65,11 @@ 
         $ret = $this->dataset->read($this->tablename, $where, 'COUNT(*)');
         if($ret === false || !isset($ret[0]) || !isset($ret[0]['COUNT(*)']))
         {
-             return false;
+                return false;
         }
         else
         {
-             return $ret[0]['COUNT(*)'];
+                return $ret[0]['COUNT(*)'];
         }
     }
   
@@ -93,8 +93,8 @@ 
 
     function update($filter, $data)
     {
-         $where = $filter->to_sql_string();
-         return $this->dataset->update($this->tablename, $where, $data);
+            $where = $filter->to_sql_string();
+            return $this->dataset->update($this->tablename, $where, $data);
     }
 
     function create($data)

Email/class.Email.php

Doc Comments +3 added lines, -3 removed lines

@@ -72,7 +72,7 @@ 
     /**
      * Who is this email going to
      *
-     * @return array The recipients of the email
+     * @return string The recipients of the email
      */
     public function getToAddresses()
     {
@@ -82,7 +82,7 @@ 
     /**
      * Who is this email going to (CC)
      *
-     * @return array The recipients of the email
+     * @return string The recipients of the email
      */
     public function getCCAddresses()
     {
@@ -92,7 +92,7 @@ 
     /**
      * Who is this email going to (BCC)
      *
-     * @return array The recipients of the email
+     * @return string The recipients of the email
      */
     public function getBCCAddresses()
     {

Email/class.EmailService.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
         return false;
     }
 
+    /**
+     * @param Email $email
+     */
     public function sendEmail($email)
     {
         return false;

LDAP/class.LDAPServer.php

Doc Comments +6 added lines

@@ -117,6 +117,9 @@ 
         $this->connect = false;
     }
 
+    /**
+     * @param string $password
+     */
     function bind($cn=null, $password=null)
     {
         $res = false;
@@ -199,6 +202,9 @@ 
         return $ret;
     }
 
+    /**
+     * @param boolean $filter
+     */
     private function filterToString($filter)
     {
         if($filter === false)

Spacing +5 added lines, -5 removed lines

@@ -76,7 +76,7 @@ 
         $this->ds = ldap_connect($this->connect);
     }
 
-    private function getConnectString($name, $proto=false)
+    private function getConnectString($name, $proto = false)
     {
         if(strstr($name, ':') !== false)
         {
@@ -89,7 +89,7 @@ 
         return $name;
     }
 
-    function connect($name, $proto=false)
+    function connect($name, $proto = false)
     {
         $connectStr = $this->getConnectString($name, $proto);
         if($this->ds !== null)
@@ -117,7 +117,7 @@ 
         $this->connect = false;
     }
 
-    function bind($cn=null, $password=null)
+    function bind($cn = null, $password = null)
     {
         $res = false;
         if($this->ds === null)
@@ -214,7 +214,7 @@ 
         return $filter->to_ldap_string();
     }
 
-    function read($baseDN, $filter=false, $single=false, $attributes=false)
+    function read($baseDN, $filter = false, $single = false, $attributes = false)
     {
         $filterStr = $this->filterToString($filter);
         if($this->ds === null)
@@ -261,7 +261,7 @@ 
         return $res;
     }
 
-    function count($baseDN, $filter=false)
+    function count($baseDN, $filter = false)
     {
         $filterStr = $this->filterToString($filter);
         if($this->ds === null)

Auth/class.LDAPGroup.php

Indentation +1 added lines, -1 removed lines

@@ -264,7 +264,7 @@
             throw new \Exception('data must be set for LDAPGroup');
         }
         $filter = new \Data\Filter("cn eq $name");
-	$group = $data->read($data->group_base, $filter);
+    $group = $data->read($data->group_base, $filter);
         if($group === false || !isset($group[0]))
         {
             return false;

Braces +4 added lines, -1 removed lines

@@ -179,7 +179,10 @@
         $count = count($groups);
         for($i = 0; $i < $count; $i++)
         {
-            if($groups[$i] === false || $groups[$i] === null) continue;
+            if($groups[$i] === false || $groups[$i] === null)
+            {
+                continue;
+            }
             array_push($data, new LDAPGroup($groups[$i]));
         }
         $users = $this->server->read($this->server->user_base, $userFilter, false, $select);