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()
     {

Spacing +2 added lines, -2 removed lines

@@ -16,14 +16,14 @@
  *
  * This class can be serialized to various formats
  */
-class SerializableObject implements ArrayAccess,JsonSerializable
+class SerializableObject implements ArrayAccess, JsonSerializable
 {
     /**
      * Create the object from an array
      *
      * @param array $array The array of object properties
      */
-    public function __construct($array=false)
+    public function __construct($array = false)
     {
         if($array !== false && is_array($array))
         {

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

Spacing +6 added lines, -6 removed lines

@@ -7,7 +7,7 @@ 
     public $var2;
     public $op;
 
-    function __construct($string=false)
+    function __construct($string = false)
     {
         if($string !== false) $this->process_filter_string($string);
     }
@@ -63,7 +63,7 @@ 
         {
             case 'substringof':
             case 'contains':
-                $str = $this->var1.' LIKE \'%'.trim($this->var2,"'").'%\'';
+                $str = $this->var1.' LIKE \'%'.trim($this->var2, "'").'%\'';
                 break;
             default:
                 $str = $this->var1.$this->op.$this->var2;
@@ -79,13 +79,13 @@ 
         {
             case 'substringof':
             case 'contains':
-                $str.=$this->var1.$this->op.'*'.trim($this->var2,"'").'*';
+                $str .= $this->var1.$this->op.'*'.trim($this->var2, "'").'*';
                 break;
             case '!=':
-                $str.='!('.$this->var1.'='.$this->var2.')';
+                $str .= '!('.$this->var1.'='.$this->var2.')';
                 break;
             default:
-                $str.=$this->var1.$this->op.$this->var2;
+                $str .= $this->var1.$this->op.$this->var2;
                 break;
         }
         return $str.')';
@@ -119,7 +119,7 @@ 
                 $case  = false;
                 if(self::str_startswith($this->var1, 'tolower'))
                 {
-                    $field = substr($this->var1, strpos($this->var1, '(')+1);
+                    $field = substr($this->var1, strpos($this->var1, '(') + 1);
                     $field = substr($field, 0, strpos($field, ')'));
                     $case = true;
                 }

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 +7 added lines, -7 removed lines

@@ -106,7 +106,7 @@ 
         throw new \Exception('No such table '.$name);
     }
 
-    function read($tablename, $where=false, $select='*', $count=false, $skip=false, $sort=false)
+    function read($tablename, $where = false, $select = '*', $count = false, $skip = false, $sort = false)
     {
         if($select === false)
         {
@@ -115,28 +115,28 @@ 
         $sql = "SELECT $select FROM $tablename";
         if($where !== false)
         {
-            $sql.=' WHERE '.$where;
+            $sql .= ' WHERE '.$where;
         }
         if($count !== false)
         {
             if($skip === false)
             {
-                $sql.=' LIMIT '.(int)$count;
+                $sql .= ' LIMIT '.(int)$count;
             }
             else
             {
-                $sql.=" LIMIT $skip, $count";
+                $sql .= " LIMIT $skip, $count";
             }
         }
         if($sort !== false)
         {
-            $sql.=' ORDER BY ';
+            $sql .= ' ORDER BY ';
             $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)

Spacing +2 added lines, -2 removed lines

@@ -51,7 +51,7 @@ 
         }
     }
 
-    function count($filter=false)
+    function count($filter = false)
     {
         if($this->data !== null)
         {
@@ -73,7 +73,7 @@ 
         }
     }
   
-    function search($filter=false, $select=false, $count=false, $skip=false, $sort=false, $params=false)
+    function search($filter = false, $select = false, $count = false, $skip = false, $sort = false, $params = false)
     {
         if($this->data !== null)
         {

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()
     {

Spacing +21 added lines, -21 removed lines

@@ -149,7 +149,7 @@ 
      * @param string $email The email address to send from
      * @param string $name  The name to associate with the from address
      */
-    public function setFromAddress($email, $name=false)
+    public function setFromAddress($email, $name = false)
     {
         $address = $email;
         if($name !== false)
@@ -165,7 +165,7 @@ 
      * @param string $email The email address to send to
      * @param string $name  The name to associate with the address
      */
-    public function addToAddress($email, $name=false)
+    public function addToAddress($email, $name = false)
     {
         $this->addAddress($this->to, $email, $name);
     }
@@ -176,7 +176,7 @@ 
      * @param string $email The email address to send to
      * @param string $name  The name to associate with the address
      */
-    public function addCCAddress($email, $name=false)
+    public function addCCAddress($email, $name = false)
     {
         $this->addAddress($this->cc, $email, $name);
     }
@@ -187,7 +187,7 @@ 
      * @param string $email The email address to send to
      * @param string $name  The name to associate with the address
      */
-    public function addBCCAddress($email, $name=false)
+    public function addBCCAddress($email, $name = false)
     {
         $this->addAddress($this->bcc, $email, $name);
     }
@@ -199,7 +199,7 @@ 
      * @param string $email The email address to send to
      * @param string $name  The name to associate with the address
      */
-    protected function addAddress(&$list, $email, $name=false)
+    protected function addAddress(&$list, $email, $name = false)
     {
         $address = $email;
         if($name !== false)
@@ -215,7 +215,7 @@ 
      * @param string $email The email address to reply to
      * @param string $name  The name to associate with the from address
      */
-    public function setReplyTo($email, $name=false)
+    public function setReplyTo($email, $name = false)
     {
         $address = $email;
         if($name !== false)
@@ -262,7 +262,7 @@ 
      */
     public function appendToHTMLBody($body)
     {
-        $this->htmlBody.= $body;
+        $this->htmlBody .= $body;
     }
 
     /**
@@ -272,7 +272,7 @@ 
      */
     public function appendToTextBody($body)
     {
-        $this->textBody.= $body;
+        $this->textBody .= $body;
     }
 
     /**
@@ -335,14 +335,14 @@ 
         {
             throw new \Exception('Message must have a from address');
         }
-        $rawMessage.= 'From: '.$this->encodeRecipients($from)."\n";
+        $rawMessage .= 'From: '.$this->encodeRecipients($from)."\n";
         if(!empty($this->cc))
         {
-            $rawMessage.= 'CC: '. $this->encodeRecipients($this->getCCAddresses())."\n";
+            $rawMessage .= 'CC: '.$this->encodeRecipients($this->getCCAddresses())."\n";
         }
         if(!empty($this->bcc))
         {
-            $rawMessage.= 'BCC: '. $this->encodeRecipients($this->getBCCAddresses())."\n";
+            $rawMessage .= 'BCC: '.$this->encodeRecipients($this->getBCCAddresses())."\n";
         }
         $rawMessage .= 'Subject: '.$this->getSubject()."\n";
         $rawMessage .= 'MIME-Version: 1.0'."\n";
@@ -352,25 +352,25 @@ 
         $textBody    = $this->getTextBody();
         if($textBody !== false && strlen($textBody) > 0)
         {
-            $rawMessage.= "\n--alt-{$boundary}\n";
-            $rawMessage.= "Content-Type: text/plain\n\n";
-            $rawMessage.= $textBody."\n";
+            $rawMessage .= "\n--alt-{$boundary}\n";
+            $rawMessage .= "Content-Type: text/plain\n\n";
+            $rawMessage .= $textBody."\n";
         }
-        $htmlBody    = $this->getHTMLBody();
+        $htmlBody = $this->getHTMLBody();
         if($htmlBody !== false && strlen($htmlBody) > 0)
         {
             $rawMessage .= "\n--alt-{$boundary}\n";
             $rawMessage .= 'Content-Type: text/html; charset="UTF-8"'."\n\n";
             $rawMessage .= $htmlBody."\n";
         }
-        $rawMessage.= "\n--alt-{$boundary}--\n";
+        $rawMessage .= "\n--alt-{$boundary}--\n";
         foreach($this->attachments as $attachment)
         {
-            $rawMessage.= "\n--{$boundary}\n";
-            $rawMessage.= 'Content-Type: '. $attachment['mimeType'].'; name="'.$attachment['name']."\"\n";
-            $rawMessage.= 'Content-Disposition: attachment'."\n";
-            $rawMessage.= 'Content-Transfer-Encoding: base64'."\n\n";
-            $rawMessage.= chunk_split(base64_encode($attachment['data']), 76, "\n")."\n";
+            $rawMessage .= "\n--{$boundary}\n";
+            $rawMessage .= 'Content-Type: '.$attachment['mimeType'].'; name="'.$attachment['name']."\"\n";
+            $rawMessage .= 'Content-Disposition: attachment'."\n";
+            $rawMessage .= 'Content-Transfer-Encoding: base64'."\n\n";
+            $rawMessage .= chunk_split(base64_encode($attachment['data']), 76, "\n")."\n";
         }
         $rawMessage .= "\n--{$boundary}--\n";
         return $rawMessage;

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;

Spacing +11 added lines, -11 removed lines

@@ -72,7 +72,7 @@ 
         return substr($split[0], 4);
     }
 
-    public function getMemberUids($recursive=true)
+    public function getMemberUids($recursive = true)
     {
         $members = array();
         $rawMembers = $this->getMembersField();
@@ -117,7 +117,7 @@ 
         return LDAPUser::from_name(substr($split[0], 4), $this->server);
     }
 
-    public function members($details=false, $recursive=true, $includeGroups=true)
+    public function members($details = false, $recursive = true, $includeGroups = true)
     {
         $members = array();
         $rawMembers = $this->getMembersField();
@@ -154,7 +154,7 @@ 
         return $members;
     }
 
-    public function getNonMemebers($select=false)
+    public function getNonMemebers($select = false)
     {
         $data = array();
         $groupFilter = '(&(cn=*)(!(cn='.$this->getGroupName().'))';
@@ -163,18 +163,18 @@ 
         $count = count($members);
         for($i = 0; $i < $count; $i++)
         {
-            $dnComps = explode(',',$members[$i]);
+            $dnComps = explode(',', $members[$i]);
             if(strncmp($members[$i], "uid=", 4) == 0)
             {
-                $userFilter.='(!('.$dnComps[0].'))';
+                $userFilter .= '(!('.$dnComps[0].'))';
             }
             else
             {
-                $groupFilter.='(!('.$dnComps[0].'))';
+                $groupFilter .= '(!('.$dnComps[0].'))';
             }
         }
-        $userFilter.=')';
-        $groupFilter.=')';
+        $userFilter .= ')';
+        $groupFilter .= ')';
         $groups = $this->server->read($this->server->group_base, $groupFilter);
         $count = count($groups);
         for($i = 0; $i < $count; $i++)
@@ -207,7 +207,7 @@ 
         }
     }
 
-    public function addMember($name, $isGroup=false, $flush=true)
+    public function addMember($name, $isGroup = false, $flush = true)
     {
         $dn = false;
         if($isGroup)
@@ -254,7 +254,7 @@ 
         }
     }
 
-    static function from_dn($dn, $data=false)
+    static function from_dn($dn, $data = false)
     {
         if($data === false)
         {
@@ -268,7 +268,7 @@ 
         return new static($group[0]);
     }
 
-    static function from_name($name, $data=false)
+    static function from_name($name, $data = false)
     {
         if($data === 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);