BurningFlipside / CommonCode

Auth/class.Authenticator.php

Doc Comments +14 added lines, -14 removed lines

@@ -24,7 +24,7 @@ 
      * @param string $username The username
      * @param string $password The password
      *
-     * @return mixed False if unsuccessfuly login, opaque data otherwise
+     * @return boolean False if unsuccessfuly login, opaque data otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -36,7 +36,7 @@ 
     /**
      * Does the data indicate a logged in user?
      *
-     * @param mixed $data The data returned from login
+     * @param \stdClass $data The data returned from login
      *
      * @return boolean True if successfully logged in, false otherwise
      *
@@ -50,7 +50,7 @@ 
     /**
      * Get the user data for the specified data
      *
-     * @param mixed $data The data returned from login
+     * @param \stdClass $data The data returned from login
      *
      * @return Auth\User The user object if successfully logged in or null otherwise
      *
@@ -93,12 +93,12 @@ 
      * Get the groups that match the filters
      *
      * @param mixed $filter The filter to use to find a set of groups
-     * @param mixed $select The list of fields to select
+     * @param boolean $select The list of fields to select
      * @param mixed $top The number of groups to select
      * @param mixed $skip The number of groups to skip
      * @param mixed $orderby The fields to sort by
      *
-     * @return array All groups that fit the filters
+     * @return boolean All groups that fit the filters
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -111,12 +111,12 @@ 
      * Get the users that match the filters
      *
      * @param mixed $filter The filter to use to find a set of users
-     * @param mixed $select The list of fields to select
+     * @param boolean $select The list of fields to select
      * @param mixed $top The number of users to select
      * @param mixed $skip The number of users to skip
      * @param mixed $orderby The fields to sort by
      *
-     * @return array All users that fit the filters
+     * @return boolean All users that fit the filters
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -129,12 +129,12 @@ 
      * Get the pending users that match the filters
      *
      * @param mixed $filter The filter to use to find a set of users
-     * @param mixed $select The list of fields to select
+     * @param boolean $select The list of fields to select
      * @param mixed $top The number of users to select
      * @param mixed $skip The number of users to skip
      * @param mixed $orderby The fields to sort by
      *
-     * @return array All users that fit the filters
+     * @return boolean All users that fit the filters
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -191,7 +191,7 @@ 
     /**
      * Get the link to login using this method
      *
-     * @return string The link to login using this method
+     * @return boolean The link to login using this method
      */
     public function getSupplementLink()
     {
@@ -215,7 +215,7 @@ 
     /**
      * Convert a pending user to an active user
      *
-     * @param Auth\PendingUser $user The user to activate
+     * @param PendingUser $user The user to activate
      *
      * @return boolean True if activated, false otherwise
      *
@@ -231,7 +231,7 @@ 
      *
      * @param string $hash The hash to search by
      *
-     * @return Auth\User The user whoes hash was specified
+     * @return boolean The user whoes hash was specified
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -245,7 +245,7 @@ 
      *
      * @param string $hash The hash to search by
      *
-     * @return Auth\PendingUser The user whoes hash was specified
+     * @return boolean The user whoes hash was specified
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -257,7 +257,7 @@ 
     /**
      * Get the host name this authenticator uses
      *
-     * @return string The host name this authenticator uses
+     * @return boolean The host name this authenticator uses
      */
     public function getHostName()
     {

Spacing +6 added lines, -6 removed lines

@@ -102,7 +102,7 @@ 
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
-    public function getGroupsByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false)
+    public function getGroupsByFilter($filter, $select = false, $top = false, $skip = false, $orderby = false)
     {
         return false;
     }
@@ -120,7 +120,7 @@ 
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
-    public function getUsersByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false)
+    public function getUsersByFilter($filter, $select = false, $top = false, $skip = false, $orderby = false)
     {
         return false;
     }
@@ -138,7 +138,7 @@ 
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
-    public function getPendingUsersByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false)
+    public function getPendingUsersByFilter($filter, $select = false, $top = false, $skip = false, $orderby = false)
     {
         return false;
     }
@@ -151,7 +151,7 @@ 
     public function getActiveUserCount()
     {
         $users = $this->getUsersByFilter(false);
-        if($users === false)
+        if ($users === false)
         {
             return 0;
         }
@@ -166,7 +166,7 @@ 
     public function getPendingUserCount()
     {
         $users = $this->getPendingUsersByFilter(false);
-        if($users === false)
+        if ($users === false)
         {
             return 0;
         }
@@ -181,7 +181,7 @@ 
     public function getGroupCount()
     {
         $groups = $this->getGroupsByFilter(false);
-        if($groups === false)
+        if ($groups === false)
         {
             return 0;
         }

Auth/class.LDAPAuthenticator.php

Doc Comments +9 added lines

@@ -279,6 +279,12 @@ 
         return $server->count($this->user_base);
     }
 
+    /**
+     * @param boolean $select
+     * @param boolean $top
+     * @param boolean $skip
+     * @param boolean $orderby
+     */
     private function processFilteringParams(&$data, &$select, $top, $skip, $orderby)
     {
         if($orderby !== false)
@@ -303,6 +309,9 @@ 
         }
     }
 
+    /**
+     * @param \Data\Filter $filter
+     */
     public function getUsersByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false)
     {
         $server = $this->get_and_bind_server();

Spacing +46 added lines, -46 removed lines

@@ -26,18 +26,18 @@ 
 {
     $count = count($array);
     $keys  = array_keys($orderby);
-    for($i = 0; $i < $count; $i++)
+    for ($i = 0; $i < $count; $i++)
     {
-        for($j = $i; $j < $count; $j++)
+        for ($j = $i; $j < $count; $j++)
         {
             $d = strcasecmp($array[$i][$keys[0]][0], $array[$j][$keys[0]][0]);
-            switch($orderby[$keys[0]])
+            switch ($orderby[$keys[0]])
             {
                 case 1:
-                    if($d > 0) swap($array, $i, $j);
+                    if ($d > 0) swap($array, $i, $j);
                     break;
                 case 0:
-                    if($d < 0) swap($array, $i, $j);
+                    if ($d < 0) swap($array, $i, $j);
                     break;
             }
         }
@@ -85,7 +85,7 @@ 
         $this->host       = $this->getHostParam($params);
         $this->user_base  = $this->getParam($params, 'user_base');
         $this->group_base = $this->getParam($params, 'group_base');
-        $this->bind_dn    = $this->getParam($params, 'bind_dn',   '$ldap_auth', 'read_write_pass');
+        $this->bind_dn    = $this->getParam($params, 'bind_dn', '$ldap_auth', 'read_write_pass');
         $this->bind_pass  = $this->getParam($params, 'bind_pass', '$ldap_auth', 'read_write_user');
     }
 
@@ -100,11 +100,11 @@ 
      */
     private function getHostParam($params)
     {
-        if(isset($params['host']))
+        if (isset($params['host']))
         {
             return $params['host'];
         }
-        if(isset(\FlipsideSettings::$ldap['proto']))
+        if (isset(\FlipsideSettings::$ldap['proto']))
         {
             return \FlipsideSettings::$ldap['proto'].'://'.\FlipsideSettings::$ldap['host'];
         }
@@ -123,17 +123,17 @@ 
      *
      * @SuppressWarnings("StaticAccess")
      */
-    private function getParam($params, $paramName, $settingsLocation='$ldap', $settingsName=false)
+    private function getParam($params, $paramName, $settingsLocation = '$ldap', $settingsName = false)
     {
-        if($settingsName === false)
+        if ($settingsName === false)
         {
             $settingsName = $paramName;
         }
-        if(isset($params[$paramName]))
+        if (isset($params[$paramName]))
         {
             return $params[$paramName];
         }
-        if($settingsLocation === '$ldap')
+        if ($settingsLocation === '$ldap')
         {
             return \FlipsideSettings::$ldap[$settingsName];
         }
@@ -149,13 +149,13 @@ 
      *
      * @SuppressWarnings("StaticAccess")
      */
-    public function get_and_bind_server($bind_write=false)
+    public function get_and_bind_server($bind_write = false)
     {
         $server = \LDAP\LDAPServer::getInstance();
         $server->user_base = $this->user_base;
         $server->group_base = $this->group_base;
         $server->connect($this->host);
-        if($bind_write === false)
+        if ($bind_write === false)
         {
             $ret = $server->bind();
         }
@@ -163,7 +163,7 @@ 
         {
             $ret = $server->bind($this->bind_dn, $this->bind_pass);
         }
-        if($ret === false)
+        if ($ret === false)
         {
             return false;
         }
@@ -181,20 +181,20 @@ 
     public function login($username, $password)
     {
         $server = $this->get_and_bind_server();
-        if($server === false)
+        if ($server === false)
         {
             return false;
         }
         $filter = new \Data\Filter("uid eq $username or mail eq $username");
         $user = $server->read($this->user_base, $filter);
-        if($user === false || count($user) === 0)
+        if ($user === false || count($user) === 0)
         {
             return false;
         }
         $user = $user[0];
         $server->unbind();
         $ret = $server->bind($user->dn, $password);
-        if($ret !== false)
+        if ($ret !== false)
         {
             return array('res'=>true, 'extended'=>$user); 
         }
@@ -210,7 +210,7 @@ 
      */
     public function isLoggedIn($data)
     {
-        if(isset($data['res']))
+        if (isset($data['res']))
         {
             return $data['res'];
         }
@@ -232,35 +232,35 @@ 
     public function getGroupByName($name)
     {
         $server = $this->get_and_bind_server();
-        if($server === false)
+        if ($server === false)
         {
             return false;
         }
         return LDAPGroup::from_name($name, $server);
     }
 
-    public function getGroupsByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false)
+    public function getGroupsByFilter($filter, $select = false, $top = false, $skip = false, $orderby = false)
     {
         $server = $this->get_and_bind_server();
-        if($server === false)
+        if ($server === false)
         {
             return false;
         }
-        if($filter === false)
+        if ($filter === false)
         {
             $filter = new \Data\Filter('cn eq *');
         }
         $groups = $server->read($this->group_base, $filter);
-        if($groups === false)
+        if ($groups === false)
         {
             return false;
         }
         $this->processFilteringParams($groups, $select, $top, $skip, $orderby);
         $count = count($groups);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
             $groups[$i] = new LDAPGroup($groups[$i]);
-            if($select !== false)
+            if ($select !== false)
             {
                 $groups[$i] = json_decode(json_encode($groups[$i]), true);
                 $groups[$i] = array_intersect_key($groups[$i], array_flip($select));
@@ -272,7 +272,7 @@ 
     public function getActiveUserCount()
     {
         $server = $this->get_and_bind_server();
-        if($server === false)
+        if ($server === false)
         {
             return false;
         }
@@ -281,50 +281,50 @@ 
 
     private function processFilteringParams(&$data, &$select, $top, $skip, $orderby)
     {
-        if($orderby !== false)
+        if ($orderby !== false)
         {
             sort_array($data, $orderby);
         }
-        if($select !== false)
+        if ($select !== false)
         {
             $select = array_flip($select);
         }
-        if($skip !== false && $top !== false)
+        if ($skip !== false && $top !== false)
         {
             $data = array_slice($data, $skip, $top);
         }
-        else if($top !== false)
+        else if ($top !== false)
         {
             $data = array_slice($data, 0, $top);
         }
-        else if($skip !== false)
+        else if ($skip !== false)
         {
             $data = array_slice($data, $skip);
         }
     }
 
-    public function getUsersByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false)
+    public function getUsersByFilter($filter, $select = false, $top = false, $skip = false, $orderby = false)
     {
         $server = $this->get_and_bind_server();
-        if($server === false)
+        if ($server === false)
         {
             return false;
         }
-        if($filter === false)
+        if ($filter === false)
         {
             $filter = new \Data\Filter('cn eq *');
         }
         $users = $server->read($this->user_base, $filter, false, $select);
-        if($users === false)
+        if ($users === false)
         {
             return false;
         }
         $this->processFilteringParams($users, $select, $top, $skip, $orderby);
         $count = count($users);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
             $tmp = new LDAPUser($users[$i]);
-            if($select !== false)
+            if ($select !== false)
             {
                 $tmp = $tmp->jsonSerialize();
                 $tmp = array_intersect_key($tmp, $select);
@@ -342,36 +342,36 @@ 
         $email = $user->getEmail();
         $new_user->setEmail($email);
         $pass = $user->getPassword();
-        if($pass !== false)
+        if ($pass !== false)
         {
             $new_user->setPass($pass);
         }
         $sn = $user->getLastName();
-        if($sn !== false)
+        if ($sn !== false)
         {
             $new_user->setLastName($sn);
         }
         $givenName = $user->getGivenName();
-        if($givenName !== false)
+        if ($givenName !== false)
         {
             $new_user->setGivenName($givenName);
         }
         $hosts = $user->getLoginProviders();
-        if($hosts !== false)
+        if ($hosts !== false)
         {
             $count = count($hosts);
-            for($i = 0; $i < $count; $i++)
+            for ($i = 0; $i < $count; $i++)
             {
                 $new_user->addLoginProvider($hosts[$i]);
             }
         }
         $ret = $new_user->flushUser();
-        if($ret)
+        if ($ret)
         {
             $user->delete();
         }
         $users = $this->getUsersByFilter(new \Data\Filter('mail eq '.$email));
-        if($users === false || !isset($users[0]))
+        if ($users === false || !isset($users[0]))
         {
             throw new \Exception('Error creating user!');
         }
@@ -381,7 +381,7 @@ 
     public function getUserByResetHash($hash)
     {
         $users = $this->getUsersByFilter(new \Data\Filter("uniqueIdentifier eq $hash"));
-        if($users === false || !isset($users[0]))
+        if ($users === false || !isset($users[0]))
         {
             return false;
         }

Braces +9 added lines, -8 removed lines

@@ -34,10 +34,14 @@ 
             switch($orderby[$keys[0]])
             {
                 case 1:
-                    if($d > 0) swap($array, $i, $j);
+                    if($d > 0) {
+                        swap($array, $i, $j);
+                    }
                     break;
                 case 0:
-                    if($d < 0) swap($array, $i, $j);
+                    if($d < 0) {
+                        swap($array, $i, $j);
+                    }
                     break;
             }
         }
@@ -158,8 +162,7 @@ 
         if($bind_write === false)
         {
             $ret = $server->bind();
-        }
-        else
+        } else
         {
             $ret = $server->bind($this->bind_dn, $this->bind_pass);
         }
@@ -292,12 +295,10 @@ 
         if($skip !== false && $top !== false)
         {
             $data = array_slice($data, $skip, $top);
-        }
-        else if($top !== false)
+        } else if($top !== false)
         {
             $data = array_slice($data, 0, $top);
-        }
-        else if($skip !== false)
+        } else if($skip !== false)
         {
             $data = array_slice($data, $skip);
         }

Auth/class.LDAPCachableObject.php

Doc Comments +12 added lines

@@ -18,6 +18,9 @@ 
         }
     }
 
+    /**
+     * @param string $fieldName
+     */
     protected function getField($fieldName)
     {
         if(!is_object($this->ldapObj))
@@ -27,6 +30,9 @@ 
         return $this->getFieldServer($fieldName);
     }
 
+    /**
+     * @param string $fieldName
+     */
     protected function getFieldSingleValue($fieldName)
     {
         if(!is_object($this->ldapObj))
@@ -36,6 +42,9 @@ 
         return $this->getFieldServerSingleValue($fieldName);
     }
 
+    /**
+     * @param string $fieldName
+     */
     protected function setField($fieldName, $fieldValue)
     {
         if(!is_object($this->ldapObj))
@@ -45,6 +54,9 @@ 
         return $this->setFieldServer($fieldName, $fieldValue);
     }
 
+    /**
+     * @param string $fieldName
+     */
     protected function appendField($fieldName, $fieldValue)
     {
         if(!is_object($this->ldapObj))

Spacing +20 added lines, -20 removed lines

@@ -9,7 +9,7 @@ 
         {
             return $this->server->update($obj);
         }
-        catch(\Exception $ex)
+        catch (\Exception $ex)
         {
             $auth = \AuthProvider::getInstance();
             $ldap = $auth->getAuthenticator('Auth\LDAPAuthenticator');
@@ -20,7 +20,7 @@ 
 
     protected function getField($fieldName)
     {
-        if(!is_object($this->ldapObj))
+        if (!is_object($this->ldapObj))
         {
             return $this->getFieldLocal($fieldName);
         }
@@ -29,7 +29,7 @@ 
 
     protected function getFieldSingleValue($fieldName)
     {
-        if(!is_object($this->ldapObj))
+        if (!is_object($this->ldapObj))
         {
             return $this->getFieldLocalSingleValue($fieldName);
         }
@@ -38,7 +38,7 @@ 
 
     protected function setField($fieldName, $fieldValue)
     {
-        if(!is_object($this->ldapObj))
+        if (!is_object($this->ldapObj))
         {
             return $this->setFieldLocal($fieldName, $fieldValue);
         }
@@ -47,7 +47,7 @@ 
 
     protected function appendField($fieldName, $fieldValue)
     {
-        if(!is_object($this->ldapObj))
+        if (!is_object($this->ldapObj))
         {
             return $this->appendFieldLocal($fieldName, $fieldValue);
         }
@@ -56,11 +56,11 @@ 
 
     private function getFieldLocal($fieldName)
     {
-        if($this->ldapObj === false)
+        if ($this->ldapObj === false)
         {
             return false;
         }
-        if(!isset($this->ldapObj[$fieldName]))
+        if (!isset($this->ldapObj[$fieldName]))
         {
             return false;
         }
@@ -70,7 +70,7 @@ 
     private function getFieldServer($fieldName)
     {
         $lowerName = strtolower($fieldName);
-        if(!isset($this->ldapObj->{$lowerName}))
+        if (!isset($this->ldapObj->{$lowerName}))
         {
             return false;
         }
@@ -79,15 +79,15 @@ 
 
     private function getFieldLocalSingleValue($fieldName)
     {
-        if($this->ldapObj === false)
+        if ($this->ldapObj === false)
         {
             return false;
         }
-        if(!isset($this->ldapObj[$fieldName]))
+        if (!isset($this->ldapObj[$fieldName]))
         {
             return false;
         }
-        if(is_array($this->ldapObj[$fieldName]))
+        if (is_array($this->ldapObj[$fieldName]))
         {
             return $this->ldapObj[$fieldName][0];
         }
@@ -97,12 +97,12 @@ 
     private function getFieldServerSingleValue($fieldName)
     {
         $lowerName = strtolower($fieldName);
-        if(!isset($this->ldapObj->{$lowerName}))
+        if (!isset($this->ldapObj->{$lowerName}))
         {
             return false;
         }
         $field = $this->ldapObj->{$lowerName};
-        if(!isset($field[0]))
+        if (!isset($field[0]))
         {
             return false;
         }
@@ -112,7 +112,7 @@ 
     private function setFieldServer($fieldName, $fieldValue)
     {
         $obj = array('dn'=>$this->ldapObj->dn);
-        if($fieldValue !== null && strlen($fieldValue) > 0)
+        if ($fieldValue !== null && strlen($fieldValue) > 0)
         {
             $obj[$fieldName] = $fieldValue;
         }
@@ -128,7 +128,7 @@ 
     private function appendFieldServer($fieldName, $fieldValue)
     {
         $obj = array('dn'=>$this->ldapObj->dn);
-        if(isset($this->ldapObj->{$fieldName}))
+        if (isset($this->ldapObj->{$fieldName}))
         {
             $obj[$fieldName] = $this->ldapObj->{$fieldName};
             $obj[$fieldName][$obj[$fieldName]['count']] = $fieldValue;
@@ -143,13 +143,13 @@ 
 
     private function setFieldLocal($fieldName, $fieldValue)
     {
-        if($this->ldapObj === false)
+        if ($this->ldapObj === false)
         {
             $this->ldapObj = array();
         }
-        if($fieldValue === null || strlen($fieldValue) === 0)
+        if ($fieldValue === null || strlen($fieldValue) === 0)
         {
-            if(isset($this->ldapObj[$fieldName]))
+            if (isset($this->ldapObj[$fieldName]))
             {
                 unset($this->ldapObj[$fieldName]);
             }
@@ -161,11 +161,11 @@ 
 
     private function appendFieldLocal($fieldName, $fieldValue)
     {
-        if($this->ldapObj === false)
+        if ($this->ldapObj === false)
         {
             $this->ldapObj = array();
         }
-        if(!isset($this->ldapObj[$fieldName]))
+        if (!isset($this->ldapObj[$fieldName]))
         {
             $this->ldapObj[$fieldName] = array();
         }

Braces +3 added lines, -6 removed lines

@@ -8,8 +8,7 @@ 
         try
         {
             return $this->server->update($obj);
-        }
-        catch(\Exception $ex)
+        } catch(\Exception $ex)
         {
             $auth = \AuthProvider::getInstance();
             $ldap = $auth->getAuthenticator('Auth\LDAPAuthenticator');
@@ -115,8 +114,7 @@ 
         if($fieldValue !== null && strlen($fieldValue) > 0)
         {
             $obj[$fieldName] = $fieldValue;
-        }
-        else
+        } else
         {
             $obj[$fieldName] = null;
         }
@@ -133,8 +131,7 @@ 
             $obj[$fieldName] = $this->ldapObj->{$fieldName};
             $obj[$fieldName][$obj[$fieldName]['count']] = $fieldValue;
             $obj[$fieldName]['count']++;
-        }
-        else
+        } else
         {
             $obj[$fieldName] = $fieldValue;
         }

Auth/class.PendingUser.php

Doc Comments +5 added lines, -6 removed lines

@@ -35,7 +35,7 @@ 
      *
      * @param string $name The name of the group to check if the user is in
      *
-     * @return true|false True if the user is in the group, false otherwise
+     * @return boolean True if the user is in the group, false otherwise
      */
     public function isInGroupNamed($name)
     {
@@ -90,7 +90,7 @@ 
      * We need the ability to obtain the user's unhashed plain text password to allow for it to be sent 
      * to the correct backend which will hash it
      *
-     * @return string The current password
+     * @return boolean The current password
      */
     public function getPassword()
     {
@@ -135,7 +135,7 @@ 
      *
      * @param string $email The user's new email address
      *
-     * @return true|false true if the user's email address was changed, false otherwise
+     * @return boolean true if the user's email address was changed, false otherwise
      */
     public function setEmail($email)
     {
@@ -146,9 +146,8 @@ 
     /**
      * Set the user's given (first) name
      *
-     * @param string $name The user's new given name
      *
-     * @return true|false true if the user's given name was changed, false otherwise
+     * @return boolean true if the user's given name was changed, false otherwise
      */
     public function setGivenName($givenName)
     {
@@ -161,7 +160,7 @@ 
      *
      * @param string $sn The user's new last name
      *
-     * @return true|false true if the user's last name was changed, false otherwise
+     * @return boolean true if the user's last name was changed, false otherwise
      */
     public function setLastName($sn)
     {

Spacing +6 added lines, -6 removed lines

@@ -49,7 +49,7 @@ 
      */
     public function getEmail()
     {
-        if(isset($this->email))
+        if (isset($this->email))
         {
             return $this->email;
         }
@@ -63,7 +63,7 @@ 
      */
     public function getGivenName()
     {
-        if(isset($this->givenName))
+        if (isset($this->givenName))
         {
             return $this->givenName;
         }
@@ -77,7 +77,7 @@ 
      */
     public function getLastName()
     {
-        if(isset($this->sn))
+        if (isset($this->sn))
         {
             return $this->sn;
         }
@@ -104,7 +104,7 @@ 
      */
     function getLoginProviders()
     {
-        if(isset($this->host))
+        if (isset($this->host))
         {
             return $this->host;
         }
@@ -120,7 +120,7 @@ 
      */
     function addLoginProvider($provider)
     {
-        if(isset($this->host))
+        if (isset($this->host))
         {
             array_push($this->host, $provider);
         }
@@ -199,7 +199,7 @@ 
                 Burning Flipside Technology Team');
         $email_msg->setSubject('Burning Flipside Registration');
         $email_provider = \EmailProvider::getInstance();
-        if($email_provider->sendEmail($email_msg) === false)
+        if ($email_provider->sendEmail($email_msg) === false)
         {
             throw new \Exception('Unable to send email!');
         }

Braces +1 added lines, -2 removed lines

@@ -123,8 +123,7 @@
         if(isset($this->host))
         {
             array_push($this->host, $provider);
-        }
-        else
+        } else
         {
             $this->host = array($provider);
         }

Auth/class.SQLAuthenticator.php

Doc Comments +20 added lines

@@ -138,6 +138,9 @@ 
          return $dataTable;
     }
 
+    /**
+     * @return boolean
+     */
     private function getPendingUserDataTable()
     {
         if(isset($this->params['pending_user_table']))
@@ -208,6 +211,14 @@ 
         return $dataTable->read($filter, $select, $top, $skip, $orderby);
     }
 
+    /**
+     * @param string $dataTableName
+     * @param string $className
+     * @param boolean $select
+     * @param boolean $top
+     * @param boolean $skip
+     * @param boolean $orderby
+     */
     private function convertDataToClass($dataTableName, $className, $filter, $select, $top, $skip, $orderby)
     {
         $data = $this->getDataByFilter($dataTableName, $filter, $select, $top, $skip, $orderby);
@@ -241,6 +252,12 @@ 
         return $dataTable->count();
     }
 
+    /**
+     * @param boolean $select
+     * @param boolean $top
+     * @param boolean $skip
+     * @param boolean $orderby
+     */
     private function searchPendingUsers($filter, $select, $top, $skip, $orderby)
     {
         $userDataTable = $this->getPendingUserDataTable();
@@ -272,6 +289,9 @@ 
         return $ret;
     }
 
+    /**
+     * @param \Data\Filter $filter
+     */
     public function getPendingUsersByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false)
 
     {

Indentation +20 added lines, -20 removed lines

@@ -116,26 +116,26 @@
 
     private function getDataTable($name, $pending=false)
     {
-         if(isset($this->dataTables[$name]) && isset($this->dataTables[$name][$pending]))
-         {
-             return $this->dataTables[$name][$pending];
-         }
-         $dataSet = $this->dataSet;
-         if($pending)
-         {
-             $dataSet = $this->pendingDataSet;
-         }
-         if($dataSet === null)
-         {
-             throw new \Exception('Unable to obtain dataset for SQL Authentication!');
-         }
-         $dataTable = $dataSet[$name];
-         if(!isset($this->dataTables[$name]))
-         {
-             $this->dataTables[$name] = array();
-         }
-         $this->dataTables[$name][$pending] = $dataTable;
-         return $dataTable;
+            if(isset($this->dataTables[$name]) && isset($this->dataTables[$name][$pending]))
+            {
+                return $this->dataTables[$name][$pending];
+            }
+            $dataSet = $this->dataSet;
+            if($pending)
+            {
+                $dataSet = $this->pendingDataSet;
+            }
+            if($dataSet === null)
+            {
+                throw new \Exception('Unable to obtain dataset for SQL Authentication!');
+            }
+            $dataTable = $dataSet[$name];
+            if(!isset($this->dataTables[$name]))
+            {
+                $this->dataTables[$name] = array();
+            }
+            $this->dataTables[$name][$pending] = $dataTable;
+            return $dataTable;
     }
 
     private function getPendingUserDataTable()

Spacing +48 added lines, -48 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 namespace Auth;
 
-if(!function_exists('password_hash') || !function_exists('password_verify')) 
+if (!function_exists('password_hash') || !function_exists('password_verify')) 
 {
     define('PASSWORD_BCRYPT', 1);
     define('PASSWORD_DEFAULT', PASSWORD_BCRYPT);
@@ -9,22 +9,22 @@ 
 
     function password_hash($password, $algo = PASSWORD_DEFAULT)
     {
-        if(is_null($password) || is_int($password))
+        if (is_null($password) || is_int($password))
         {
             $password = (string)$password;
         }
-        if(!is_string($password))
+        if (!is_string($password))
         {
             trigger_error("password_hash(): Password must be a string", E_USER_WARNING);
             return false;
         }
-        if(!is_int($algo))
+        if (!is_int($algo))
         {
-            trigger_error("password_hash() expects parameter 2 to be long, " . gettype($algo) . " given", E_USER_WARNING);
+            trigger_error("password_hash() expects parameter 2 to be long, ".gettype($algo)." given", E_USER_WARNING);
             return false;
         }
         $resultLength = 0;
-        switch($algo)
+        switch ($algo)
         {
             case PASSWORD_BCRYPT:
                 $cost = PASSWORD_BCRYPT_DEFAULT_COST;
@@ -43,9 +43,9 @@ 
         $base64String = base64_encode($salt);
         $salt = strtr(rtrim($base64String, '='), $base64Digits, $bcrypt64Digits);
         $salt = substr($salt, 0, $requiredSaltLen);
-        $hash = $hashFormat . $salt;
+        $hash = $hashFormat.$salt;
         $ret = crypt($password, $hash);
-        if(!is_string($ret) || strlen($ret) != $resultLength)
+        if (!is_string($ret) || strlen($ret) != $resultLength)
         {
             return false;
         }
@@ -55,13 +55,13 @@ 
     function password_verify($password, $hash)
     {
         $ret = crypt($password, $hash);
-        if(!is_string($ret) || strlen($ret) != strlen($hash) || strlen($ret) <= 13)
+        if (!is_string($ret) || strlen($ret) != strlen($hash) || strlen($ret) <= 13)
         {
             return false;
         }
         $status = 0;
         $count  = strlen($ret);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
             $status |= (ord($ret[$i]) ^ ord($hash[$i]));
         }
@@ -80,11 +80,11 @@ 
     {
         parent::__construct($params);
         $this->params = $params;
-        if($this->current)
+        if ($this->current)
         {
             $this->dataSet = $this->getCurrentDataSet();
         }
-        if($this->pending)
+        if ($this->pending)
         {
             $this->pendingDataSet = $this->getPendingDataSet();
         }
@@ -95,7 +95,7 @@ 
      */
     private function getCurrentDataSet()
     {
-        if(isset($this->params['current_data_set']))
+        if (isset($this->params['current_data_set']))
         {
             return \DataSetFactory::get_data_set($this->params['current_data_set']);
         }
@@ -107,30 +107,30 @@ 
      */
     private function getPendingDataSet()
     {
-        if(isset($this->params['pending_data_set']))
+        if (isset($this->params['pending_data_set']))
         {
             return \DataSetFactory::get_data_set($this->params['pending_data_set']);
         }
         return \DataSetFactory::get_data_set('pending_authentication');
     }
 
-    private function getDataTable($name, $pending=false)
+    private function getDataTable($name, $pending = false)
     {
-         if(isset($this->dataTables[$name]) && isset($this->dataTables[$name][$pending]))
+         if (isset($this->dataTables[$name]) && isset($this->dataTables[$name][$pending]))
          {
              return $this->dataTables[$name][$pending];
          }
          $dataSet = $this->dataSet;
-         if($pending)
+         if ($pending)
          {
              $dataSet = $this->pendingDataSet;
          }
-         if($dataSet === null)
+         if ($dataSet === null)
          {
              throw new \Exception('Unable to obtain dataset for SQL Authentication!');
          }
          $dataTable = $dataSet[$name];
-         if(!isset($this->dataTables[$name]))
+         if (!isset($this->dataTables[$name]))
          {
              $this->dataTables[$name] = array();
          }
@@ -140,7 +140,7 @@ 
 
     private function getPendingUserDataTable()
     {
-        if(isset($this->params['pending_user_table']))
+        if (isset($this->params['pending_user_table']))
         {
             return $this->getDataTable($this->params['pending_user_table'], true);
         }
@@ -149,15 +149,15 @@ 
 
     public function login($username, $password)
     {
-        if($this->current === false) return false;
+        if ($this->current === false) return false;
         $userDataTable = $this->getDataTable('user');
         $filter = new \Data\Filter("uid eq '$username'");
         $users = $userDataTable->read($filter, 'uid,pass');
-        if($users === false || !isset($users[0]))
+        if ($users === false || !isset($users[0]))
         {
             return false;
         }
-        if(password_verify($password, $users[0]['pass']))
+        if (password_verify($password, $users[0]['pass']))
         {
             return array('res'=>true, 'extended'=>$users[0]['uid']);
         }
@@ -166,7 +166,7 @@ 
 
     public function isLoggedIn($data)
     {
-        if(isset($data['res']))
+        if (isset($data['res']))
         {
             return $data['res'];
         }
@@ -183,7 +183,7 @@ 
         $groupDataTable = $this->getDataTable('group');
         $filter = new \Data\Filter("gid eq '$name'");
         $groups = $groupDataTable->read($filter);
-        if($groups === false || !isset($groups[0]))
+        if ($groups === false || !isset($groups[0]))
         {
             return false;
         }
@@ -195,7 +195,7 @@ 
         $userDataTable = $this->getDataTable('user');
         $filter = new \Data\Filter("uid eq '$name'");
         $users = $userDataTable->read($filter);
-        if($users === false || !isset($users[0]))
+        if ($users === false || !isset($users[0]))
         {
             return false;
         }
@@ -211,33 +211,33 @@ 
     private function convertDataToClass($dataTableName, $className, $filter, $select, $top, $skip, $orderby)
     {
         $data = $this->getDataByFilter($dataTableName, $filter, $select, $top, $skip, $orderby);
-        if($data === false)
+        if ($data === false)
         {
             return false;
         }
         $count = count($data);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
             $data[$i] = new $className($groups[$i]);
         }
         return $data;
     }
 
-    public function getGroupsByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false)
+    public function getGroupsByFilter($filter, $select = false, $top = false, $skip = false, $orderby = false)
     {
         return $this->convertDataToClass('group', 'SQLGroup', $filter, $select, $top, $skip, $orderby);
     }
 
-    public function getUsersByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false)
+    public function getUsersByFilter($filter, $select = false, $top = false, $skip = false, $orderby = false)
     {
         return $this->convertDataToClass('group', 'SQLUser', $filter, $select, $top, $skip, $orderby);
     }
 
     public function getPendingUserCount()
     {
-        if($this->pending === false) return 0;
+        if ($this->pending === false) return 0;
         $dataTable = $this->getPendingUserDataTable();
-        if($dataTable === null) return 0;
+        if ($dataTable === null) return 0;
         return $dataTable->count();
     }
 
@@ -245,26 +245,26 @@ 
     {
         $userDataTable = $this->getPendingUserDataTable();
         $fieldData = $filter->to_mongo_filter();
-        $firstFilter = new \Data\Filter('substringof(data,"'.implode($fieldData,' ').'")');
+        $firstFilter = new \Data\Filter('substringof(data,"'.implode($fieldData, ' ').'")');
         $users = $userDataTable->read($firstFilter, $select, $top, $skip, $orderby);
-        if($users === false)
+        if ($users === false)
         {
             return false;
         }
         $ret = array();
         $count = count($users);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
             $user = new SQLPendingUser($users[$i], $userDataTable);
             $err = false;
-            foreach($fieldData as $field=>$data)
+            foreach ($fieldData as $field=>$data)
             {
-                if(strcasecmp($user[$field], $data) !== 0)
+                if (strcasecmp($user[$field], $data) !== 0)
                 {
                     $err = true; break;
                 }
             }
-            if(!$err)
+            if (!$err)
             {
                 array_push($ret, $user);
             }
@@ -272,22 +272,22 @@ 
         return $ret;
     }
 
-    public function getPendingUsersByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false)
+    public function getPendingUsersByFilter($filter, $select = false, $top = false, $skip = false, $orderby = false)
 
     {
-        if($this->pending === false) return false;
-        if($filter !== false && !$filter->contains('hash'))
+        if ($this->pending === false) return false;
+        if ($filter !== false && !$filter->contains('hash'))
         {
             return $this->searchPendingUsers($filter, $select, $top, $skip, $orderby);
         }
         $userDataTable = $this->getPendingUserDataTable();
         $users = $userDataTable->read($filter, $select, $top, $skip, $orderby);
-        if($users === false)
+        if ($users === false)
         {
             return false;
         }
         $count = count($users);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
             $users[$i] = new SQLPendingUser($users[$i], $userDataTable);
         }
@@ -296,9 +296,9 @@ 
 
     public function createPendingUser($user)
     {
-        if($this->pending === false) return false;
+        if ($this->pending === false) return false;
         $userDataTable = $this->getPendingUserDataTable();
-        if(isset($user->password2))
+        if (isset($user->password2))
         {
             unset($user->password2);
         }
@@ -306,10 +306,10 @@ 
         $hash = hash('sha512', $json);
         $array = array('hash'=>$hash, 'data'=>$json);
         $ret = $userDataTable->create($array);
-        if($ret !== false)
+        if ($ret !== false)
         {
             $users = $this->getPendingUsersByFilter(new \Data\Filter("hash eq '$hash'"));
-            if($users === false || !isset($users[0]))
+            if ($users === false || !isset($users[0]))
             {
                 throw new \Exception('Error retreiving user object after successful create!');
             }
@@ -321,7 +321,7 @@ 
     public function getTempUserByHash($hash)
     {
         $users = $this->getPendingUsersByFilter(new \Data\Filter("hash eq '$hash'"));
-        if($users === false || !isset($users[0]))
+        if ($users === false || !isset($users[0]))
         {
             return false;
         }

Braces +15 added lines, -5 removed lines

@@ -149,7 +149,9 @@ 
 
     public function login($username, $password)
     {
-        if($this->current === false) return false;
+        if($this->current === false) {
+            return false;
+        }
         $userDataTable = $this->getDataTable('user');
         $filter = new \Data\Filter("uid eq '$username'");
         $users = $userDataTable->read($filter, 'uid,pass');
@@ -235,9 +237,13 @@ 
 
     public function getPendingUserCount()
     {
-        if($this->pending === false) return 0;
+        if($this->pending === false) {
+            return 0;
+        }
         $dataTable = $this->getPendingUserDataTable();
-        if($dataTable === null) return 0;
+        if($dataTable === null) {
+            return 0;
+        }
         return $dataTable->count();
     }
 
@@ -275,7 +281,9 @@ 
     public function getPendingUsersByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false)
 
     {
-        if($this->pending === false) return false;
+        if($this->pending === false) {
+            return false;
+        }
         if($filter !== false && !$filter->contains('hash'))
         {
             return $this->searchPendingUsers($filter, $select, $top, $skip, $orderby);
@@ -296,7 +304,9 @@ 
 
     public function createPendingUser($user)
     {
-        if($this->pending === false) return false;
+        if($this->pending === false) {
+            return false;
+        }
         $userDataTable = $this->getPendingUserDataTable();
         if(isset($user->password2))
         {

Auth/class.User.php

Doc Comments +43 added lines, -43 removed lines

@@ -31,7 +31,7 @@ 
      *
      * @param string $name The name of the group to check if the user is in
      *
-     * @return true|false True if the user is in the group, false otherwise
+     * @return boolean True if the user is in the group, false otherwise
      */
     function isInGroupNamed($name)
     {
@@ -41,7 +41,7 @@ 
     /**
      * The name the user should be displayed as
      *
-     * @return string The name the user should be displayed as
+     * @return boolean The name the user should be displayed as
      */
     function getDisplayName()
     {
@@ -51,7 +51,7 @@ 
     /**
      * The given (or first) name for the user
      *
-     * @return string The user's first name
+     * @return boolean The user's first name
      */
     function getGivenName()
     {
@@ -61,7 +61,7 @@ 
     /**
      * The email address for the user
      *
-     * @return string The user's email address
+     * @return boolean The user's email address
      */
     function getEmail()
     {
@@ -71,7 +71,7 @@ 
     /**
      * The user ID for the user
      *
-     * @return string The user's ID or username
+     * @return boolean The user's ID or username
      */
     function getUid()
     {
@@ -81,7 +81,7 @@ 
     /**
      * The photo for the user
      *
-     * @return string The user's photo as a binary string
+     * @return boolean The user's photo as a binary string
      */ 
     function getPhoto()
     {
@@ -91,7 +91,7 @@ 
     /**
      * The phone number for the user
      *
-     * @return string The user's phone number
+     * @return boolean The user's phone number
      */
     function getPhoneNumber()
     {
@@ -101,7 +101,7 @@ 
     /**
      * The organziation for the user
      *
-     * @return string The user's organization
+     * @return boolean The user's organization
      */
     function getOrganization()
     {
@@ -111,7 +111,7 @@ 
     /**
      * The list of titles for the user
      *
-     * @return array The user's title(s) in short format
+     * @return boolean The user's title(s) in short format
      */
     function getTitles()
     {
@@ -121,7 +121,7 @@ 
     /**
      * The list of titles for the user
      *
-     * @return array The user's title(s) in user friendly strings
+     * @return boolean The user's title(s) in user friendly strings
      *
      * @SuppressWarnings("StaticAccess")
      */
@@ -159,7 +159,7 @@ 
     /**
      * The state the user's mailing address is in
      *
-     * @return string The user's state from their mailing address
+     * @return boolean The user's state from their mailing address
      */
     function getState()
     {
@@ -169,7 +169,7 @@ 
     /**
      * The city the user's mailing address is in
      *
-     * @return string The user's city from their mailing address
+     * @return boolean The user's city from their mailing address
      */
     function getCity()
     {
@@ -179,7 +179,7 @@ 
     /**
      * The last name for the user
      *
-     * @return string The user's last name
+     * @return boolean The user's last name
      */
     function getLastName()
     {
@@ -189,7 +189,7 @@ 
     /**
      * The nick name for the user
      *
-     * @return string The user's nick name
+     * @return boolean The user's nick name
      */
     function getNickName()
     {
@@ -199,7 +199,7 @@ 
     /**
      * The street address for the user
      *
-     * @return string The user's street address
+     * @return boolean The user's street address
      */
     function getAddress()
     {
@@ -209,7 +209,7 @@ 
     /**
      * The postal (zip) code for the user's mailing address
      *
-     * @return string The user's postal code
+     * @return boolean The user's postal code
      */
     function getPostalCode()
     {
@@ -219,7 +219,7 @@ 
     /**
      * The country the user's mailing address is in
      *
-     * @return string The user's country from their mailing address
+     * @return boolean The user's country from their mailing address
      */
     function getCountry()
     {
@@ -231,7 +231,7 @@ 
      *
      * This is the same as Areas in Flipside speak. 
      *
-     * @return array The user's orgnaiational units
+     * @return boolean The user's orgnaiational units
      */
     function getOrganizationUnits()
     {
@@ -241,7 +241,7 @@ 
     /**
      * The supplemental login types that the user can use to login
      *
-     * @return array The user's login providers
+     * @return boolean The user's login providers
      */
     function getLoginProviders()
     {
@@ -251,7 +251,7 @@ 
     /**
      * The groups the user is a part of
      *
-     * @return array The user's Auth\Group structures
+     * @return boolean The user's Auth\Group structures
      */
     function getGroups()
     {
@@ -275,7 +275,7 @@ 
      *
      * @param string $provider The hostname for the provider
      *
-     * @return true|false true if they can login with the provider, false otherwise
+     * @return boolean true if they can login with the provider, false otherwise
      */
     function canLoginWith($provider)
     {
@@ -294,7 +294,7 @@ 
      *
      * @param string $password The new user password
      *
-     * @return true|false true if the user's password was changed, false otherwise
+     * @return boolean true if the user's password was changed, false otherwise
      */
     protected function setPass($password)
     {
@@ -304,7 +304,7 @@ 
     /**
      * Has the user completely filled out their user profile?
      *
-     * @return true|false true if the user's profile is complete, false otherwise
+     * @return boolean true if the user's profile is complete, false otherwise
      */
     function isProfileComplete()
     {
@@ -322,7 +322,7 @@ 
      *
      * @param string $password The user's current password
      *
-     * @return true|false true if the user's password is correct, false otherwise
+     * @return boolean true if the user's password is correct, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -336,7 +336,7 @@ 
      *
      * @param string $hash The user's reset hash
      *
-     * @return true|false true if the user's hash is correct, false otherwise
+     * @return boolean true if the user's hash is correct, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -352,7 +352,7 @@ 
      * @param string $newpass The user's new password
      * @param boolean $isHash Is $old_pass a password or a hash
      *
-     * @return true|false true if the user's password was changed, false otherwise
+     * @return boolean true if the user's password was changed, false otherwise
      */
     function change_pass($oldpass, $newpass, $isHash=false)
     {
@@ -376,7 +376,7 @@ 
      *
      * @param string $name The user's new display name
      *
-     * @return true|false true if the user's display name was changed, false otherwise
+     * @return boolean true if the user's display name was changed, false otherwise
      */
     function setDisplayName($name)
     {
@@ -388,7 +388,7 @@ 
      *
      * @param string $name The user's new given name
      *
-     * @return true|false true if the user's given name was changed, false otherwise
+     * @return boolean true if the user's given name was changed, false otherwise
      */
     function setGivenName($name)
     {
@@ -400,7 +400,7 @@ 
      *
      * @param string $email The user's new email address
      *
-     * @return true|false true if the user's email address was changed, false otherwise
+     * @return boolean true if the user's email address was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -414,7 +414,7 @@ 
      *
      * @param string $uid The user's new user ID
      *
-     * @return true|false true if the user's ID was changed, false otherwise
+     * @return boolean true if the user's ID was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -428,7 +428,7 @@ 
      *
      * @param string $photo The user's new photo as a binary string
      *
-     * @return true|false true if the user's photo was changed, false otherwise
+     * @return boolean true if the user's photo was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -442,7 +442,7 @@ 
      *
      * @param string $phone The user's new phonew number
      *
-     * @return true|false true if the user's phone number was changed, false otherwise
+     * @return boolean true if the user's phone number was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -456,7 +456,7 @@ 
      *
      * @param string $org The user's new organization
      *
-     * @return true|false true if the user's organization was changed, false otherwise
+     * @return boolean true if the user's organization was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -470,7 +470,7 @@ 
      *
      * @param string $titles The user's new titles
      *
-     * @return true|false true if the user's titles were changed, false otherwise
+     * @return boolean true if the user's titles were changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -484,7 +484,7 @@ 
      *
      * @param string $state The user's new state
      *
-     * @return true|false true if the user's state was changed, false otherwise
+     * @return boolean true if the user's state was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -498,7 +498,7 @@ 
      *
      * @param string $city The user's new city
      *
-     * @return true|false true if the user's city was changed, false otherwise
+     * @return boolean true if the user's city was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -512,7 +512,7 @@ 
      *
      * @param string $sn The user's new last name
      *
-     * @return true|false true if the user's last name was changed, false otherwise
+     * @return boolean true if the user's last name was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -526,7 +526,7 @@ 
      *
      * @param string $displayName The user's new nick name
      *
-     * @return true|false true if the user's nick name was changed, false otherwise
+     * @return boolean true if the user's nick name was changed, false otherwise
      */
     function setNickName($displayName)
     {
@@ -538,7 +538,7 @@ 
      *
      * @param string $address The user's new mailing address
      *
-     * @return true|false true if the user's mailing address was changed, false otherwise
+     * @return boolean true if the user's mailing address was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -552,7 +552,7 @@ 
      *
      * @param string $postalcode The user's new postal code
      *
-     * @return true|false true if the user's postal code was changed, false otherwise
+     * @return boolean true if the user's postal code was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -566,7 +566,7 @@ 
      *
      * @param string $country The user's new country
      *
-     * @return true|false true if the user's country was changed, false otherwise
+     * @return boolean true if the user's country was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -580,7 +580,7 @@ 
      *
      * @param string $ous The user's new organizations
      *
-     * @return true|false true if the user's organizations was changed, false otherwise
+     * @return boolean true if the user's organizations was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -704,7 +704,7 @@ 
     /**
      * Obtain the user's password reset hash
      *
-     * @return string|false A hash if available, false otherwise
+     * @return boolean A hash if available, false otherwise
      */
     public function getPasswordResetHash()
     {

Spacing +41 added lines, -41 removed lines

@@ -128,26 +128,26 @@ 
     function getTitleNames()
     {
         $titles = $this->getTitles();
-        if($titles === false)
+        if ($titles === false)
         {
             return false;
         }
-        if(self::$titlenames === null)
+        if (self::$titlenames === null)
         {
             $dataSet = \DataSetFactory::get_data_set('profiles');
             $dataTable = $dataSet['position'];
             $titlenames = $dataTable->read();
             self::$titlenames = array();
             $count = count($titlenames);
-            for($i = 0; $i < $count; $i++)
+            for ($i = 0; $i < $count; $i++)
             {
                 self::$titlenames[$titlenames[$i]['short_name']] = $titlenames[$i];
             }
         }
         $count = count($titles);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
-            if(isset(self::$titlenames[$titles[$i]]))
+            if (isset(self::$titlenames[$titles[$i]]))
             {
                 $title = self::$titlenames[$titles[$i]];
                 $titles[$i] = $title['name'];
@@ -280,11 +280,11 @@ 
     function canLoginWith($provider)
     {
         $hosts = $this->getLoginProviders();
-        if($hosts === false) return false;
+        if ($hosts === false) return false;
         $count = count($hosts);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
-            if(strcasecmp($hosts[$i], $provider) === 0) return true;
+            if (strcasecmp($hosts[$i], $provider) === 0) return true;
         }
         return false;
     }
@@ -308,9 +308,9 @@ 
      */
     function isProfileComplete()
     {
-        if($this->getCountry() === false    || $this->getAddress() === false ||
+        if ($this->getCountry() === false || $this->getAddress() === false ||
            $this->getPostalCode() === false || $this->getCity() === false ||
-           $this->getState() === false      || $this->getPhoneNumber() === false)
+           $this->getState() === false || $this->getPhoneNumber() === false)
         {
             return false;
         }
@@ -354,17 +354,17 @@ 
      *
      * @return true|false true if the user's password was changed, false otherwise
      */
-    function change_pass($oldpass, $newpass, $isHash=false)
+    function change_pass($oldpass, $newpass, $isHash = false)
     {
-        if($isHash === false && $this->validate_password($oldpass) === false)
+        if ($isHash === false && $this->validate_password($oldpass) === false)
         {
             throw new \Exception('Invalid Password!', 3);
         }
-        if($isHash === true && $this->validate_reset_hash($oldpass) === false)
+        if ($isHash === true && $this->validate_reset_hash($oldpass) === false)
         {
             throw new \Exception('Invalid Reset Hash!', 3);
         }
-        if($this->setPass($newpass) === false)
+        if ($this->setPass($newpass) === false)
         {
             throw new \Exception('Unable to set password!', 6);
         }
@@ -602,99 +602,99 @@ 
         $auth = \AuthProvider::getInstance();
         $ldap = $auth->getAuthenticator('Auth\LDAPAuthenticator');
         $ldap->get_and_bind_server(true);
-        if(isset($data->oldpass) && isset($data->password))
+        if (isset($data->oldpass) && isset($data->password))
         {
             $this->change_pass($data->oldpass, $data->password);
             unset($data->oldpass);
             unset($data->password);
         }
-        else if(isset($data->hash) && isset($data->password))
+        else if (isset($data->hash) && isset($data->password))
         {
             $this->change_pass($data->hash, $data->password, true);
             return;
         }
-        if(isset($data->displayName))
+        if (isset($data->displayName))
         {
             $this->setDisplayName($data->displayName);
             unset($data->displayName);
         }
-        if(isset($data->givenName))
+        if (isset($data->givenName))
         {
             $this->setGivenName($data->givenName);
             unset($data->givenName);
         }
-        if(isset($data->jpegPhoto))
+        if (isset($data->jpegPhoto))
         {
             $this->setPhoto(base64_decode($data->jpegPhoto));
             unset($data->jpegPhoto);
         }
-        if(isset($data->mail))
+        if (isset($data->mail))
         {
-            if($data->mail !== $this->getEmail())
+            if ($data->mail !== $this->getEmail())
             {
                 throw new \Exception('Unable to change email!');
             }
             unset($data->mail);
         }
-        if(isset($data->uid))
+        if (isset($data->uid))
         {
-            if($data->uid !== $this->getUid())
+            if ($data->uid !== $this->getUid())
             {
                 throw new \Exception('Unable to change uid!');
             }
             unset($data->uid);
         }
-        if(isset($data->mobile))
+        if (isset($data->mobile))
         {
             $this->setPhoneNumber($data->mobile);
             unset($data->mobile);
         }
-        if(isset($data->o))
+        if (isset($data->o))
         {
             $this->setOrganization($data->o);
             unset($data->o);
         }
-        if(isset($data->title))
+        if (isset($data->title))
         {
             $this->setTitles($data->title);
             unset($data->title);
         }
-        if(isset($data->st))
+        if (isset($data->st))
         {
             $this->setState($data->st);
             unset($data->st);
         }
-        if(isset($data->l))
+        if (isset($data->l))
         {
             $this->setCity($data->l);
             unset($data->l);
         }
-        if(isset($data->sn))
+        if (isset($data->sn))
         {
             $this->setLastName($data->sn);
             unset($data->sn);
         }
-        if(isset($data->cn))
+        if (isset($data->cn))
         {
             $this->setNickName($data->cn);
             unset($data->cn);
         }
-        if(isset($data->postalAddress))
+        if (isset($data->postalAddress))
         {
             $this->setAddress($data->postalAddress);
             unset($data->postalAddress);
         }
-        if(isset($data->postalCode))
+        if (isset($data->postalCode))
         {
             $this->setPostalCode($data->postalCode);
             unset($data->postalCode);
         }
-        if(isset($data->c))
+        if (isset($data->c))
         {
             $this->setCountry($data->c);
             unset($data->c);
         }
-        if(isset($data->ou))
+        if (isset($data->ou))
         {
             $this->setOrganizationUnits($data->ou);
             unset($data->ou);
@@ -749,13 +749,13 @@ 
     public function getVcard()
     {
         $ret = "BEGIN:VCARD\nVERSION:2.1\n";
-        $ret.= 'N:'.$this->getLastName().';'.$this->getGivenName()."\n";
-        $ret.= 'FN:'.$this->getGivenName()."\n";
-        $ret.= 'TITLE:'.implode(',', $this->getTitles())."\n";
-        $ret.= "ORG: Austin Artistic Reconstruction\n";
-        $ret.= 'TEL;TYPE=MOBILE,VOICE:'.$this->getPhoneNumber()."\n";
-        $ret.= 'EMAIL;TYPE=PREF,INTERNET:'.$this->getEmail()."\n";
-        $ret.= "END:VCARD\n";
+        $ret .= 'N:'.$this->getLastName().';'.$this->getGivenName()."\n";
+        $ret .= 'FN:'.$this->getGivenName()."\n";
+        $ret .= 'TITLE:'.implode(',', $this->getTitles())."\n";
+        $ret .= "ORG: Austin Artistic Reconstruction\n";
+        $ret .= 'TEL;TYPE=MOBILE,VOICE:'.$this->getPhoneNumber()."\n";
+        $ret .= 'EMAIL;TYPE=PREF,INTERNET:'.$this->getEmail()."\n";
+        $ret .= "END:VCARD\n";
         return $ret;
     }
 }

Braces +7 added lines, -4 removed lines

@@ -280,11 +280,15 @@ 
     function canLoginWith($provider)
     {
         $hosts = $this->getLoginProviders();
-        if($hosts === false) return false;
+        if($hosts === false) {
+            return false;
+        }
         $count = count($hosts);
         for($i = 0; $i < $count; $i++)
         {
-            if(strcasecmp($hosts[$i], $provider) === 0) return true;
+            if(strcasecmp($hosts[$i], $provider) === 0) {
+                return true;
+            }
         }
         return false;
     }
@@ -607,8 +611,7 @@ 
             $this->change_pass($data->oldpass, $data->password);
             unset($data->oldpass);
             unset($data->password);
-        }
-        else if(isset($data->hash) && isset($data->password))
+        } else if(isset($data->hash) && isset($data->password))
         {
             $this->change_pass($data->hash, $data->password, true);
             return;

Auth/OAuth2/class.OAuth2Authenticator.php

Doc Comments +1 added lines, -1 removed lines

@@ -109,7 +109,7 @@
      * @param $params The set of parameters obtained from the authentication call
      * @param $current_user The user from the current system if the user is not authorized to login via this method
      *
-     * @return SUCCESS|LOGIN_FAILED|ALREADY_PRESENT SUCCESS if the user is now logged in. ALREADY_PRESENT if the authorization was
+     * @return integer SUCCESS if the user is now logged in. ALREADY_PRESENT if the authorization was
      *                                              successful, but the user has not authorized that login method. LOGIN_FAILED for all other errors
      */
     public function authenticate($params, &$current_user)

Spacing +7 added lines, -7 removed lines

@@ -14,7 +14,7 @@ 
 namespace Auth\OAuth2;
 
 /** Only load the HTTPFul bootstrap if it isn't already loaded*/
-if(!class_exists('Httpful\Request'))
+if (!class_exists('Httpful\Request'))
 {
     require('/var/www/common/libs/httpful/bootstrap.php');
 }
@@ -37,7 +37,7 @@ 
     public function __construct($params)
     {
         parent::__construct($params);
-        if(!isset($params['redirect_url']))
+        if (!isset($params['redirect_url']))
         {
             $this->redirect_uri = 'https://'.$_SERVER['HTTP_HOST'].'/oauth/callbacks/'.$this->getHostName();
         }
@@ -115,21 +115,21 @@ 
     public function authenticate($params, &$current_user)
     {
         $resp = $this->doAuthPost($params);
-        if($resp->hasErrors())
+        if ($resp->hasErrors())
         {
             return self::LOGIN_FAILED; 
         }
         \FlipSession::setVar('OAuthToken', $resp->body);
         $user = $this->getUserFromToken($resp->body);
-        if($user === false)
+        if ($user === false)
         {
             return self::LOGIN_FAILED;
         }
         $auth = \AuthProvider::getInstance();
         $local_users = $auth->getUsersByFilter(new \Data\Filter('mail eq '.$user->getEmail()));
-        if($local_users !== false && isset($local_users[0]))
+        if ($local_users !== false && isset($local_users[0]))
         {
-            if($local_users[0]->canLoginWith($this->getHostName()))
+            if ($local_users[0]->canLoginWith($this->getHostName()))
             {
                 $auth->impersonateUser($local_users[0]);
                 return self::SUCCESS;
@@ -138,7 +138,7 @@ 
             return self::ALREADY_PRESENT;
         }
         $ret = $auth->activatePendingUser($user);
-        if($ret === false)
+        if ($ret === false)
         {
             throw new \Exception('Unable to create user! '.$res);
         }

Braces +1 added lines, -2 removed lines

@@ -40,8 +40,7 @@
         if(!isset($params['redirect_url']))
         {
             $this->redirect_uri = 'https://'.$_SERVER['HTTP_HOST'].'/oauth/callbacks/'.$this->getHostName();
-        }
-        else
+        } else
         {
             $this->redirect_uri = $params['redirect_url'];
         }

class.AuthProvider.php

Doc Comments +6 added lines, -6 removed lines

@@ -53,7 +53,7 @@ 
      *
      * @param string $methodName The class name of the Authenticator to get the instance for
      *
-     * @return Auth\Authenticator|false The specified Authenticator class instance or false if it is not loaded
+     * @return string The specified Authenticator class instance or false if it is not loaded
      */
     public function getAuthenticator($methodName)
     {
@@ -269,11 +269,11 @@ 
      * Get an array of Auth\PendingUser from a filtered set
      *
      * @param Data\Filter|false $filter The filter conditions or false to retreive all
-     * @param array|false $methodName The user fields to obtain or false to obtain all
-     * @param integer|false $top The number of users to obtain or false to obtain all
-     * @param integer|false $skip The number of users to skip or false to skip none
-     * @param array|false $orderby The field to sort by and the method to sort or false to not sort
-     * @param string|false $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator
+     * @param boolean $methodName 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 boolean $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator
      *
      * @return array|false An array of Auth\PendingUser objects or false if no pending users were found
      */

Spacing +52 added lines, -52 removed lines

@@ -36,11 +36,11 @@ 
     protected function __construct()
     {
         $this->methods = array();
-        if(isset(FlipsideSettings::$authProviders))
+        if (isset(FlipsideSettings::$authProviders))
         {
             $keys = array_keys(FlipsideSettings::$authProviders);
             $count = count($keys);
-            for($i = 0; $i < $count; $i++)
+            for ($i = 0; $i < $count; $i++)
             {
                 $class = $keys[$i];
                 array_push($this->methods, new $class(FlipsideSettings::$authProviders[$keys[$i]]));
@@ -58,9 +58,9 @@ 
     public function getAuthenticator($methodName)
     {
         $count = count($this->methods);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
-            if(strcasecmp(get_class($this->methods[$i]), $methodName) === 0)
+            if (strcasecmp(get_class($this->methods[$i]), $methodName) === 0)
             {
                 return $this->methods[$i];
             }
@@ -82,10 +82,10 @@ 
     {
         $res = false;
         $count = count($this->methods);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
             $res = $this->methods[$i]->login($username, $password);
-            if($res !== false)
+            if ($res !== false)
             {
                 return $this->methods[$i]->getUser($res);
             }
@@ -105,10 +105,10 @@ 
     {
         $res = false;
         $count = count($this->methods);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
             $res = $this->methods[$i]->login($username, $password);
-            if($res !== false)
+            if ($res !== false)
             {
                 FlipSession::setVar('AuthMethod', get_class($this->methods[$i]));
                 FlipSession::setVar('AuthData', $res);
@@ -156,11 +156,11 @@ 
      */
     private function mergeResult(&$returnValue, $res)
     {
-        if($res === false)
+        if ($res === false)
         {
             return;
         }
-        if($returnValue === false)
+        if ($returnValue === false)
         {
             $returnValue = $res;
             return;
@@ -182,11 +182,11 @@ 
     {
         $ret = false;
         $count = count($this->methods);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
-            if($checkField)
+            if ($checkField)
             {
-                if($this->methods[$i]->{$checkField} === $checkValue)
+                if ($this->methods[$i]->{$checkField} === $checkValue)
                 {
                     continue;
                 }
@@ -210,11 +210,11 @@ 
     {
         $retCount = 0;
         $count = count($this->methods);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
-            if($checkField)
+            if ($checkField)
             {
-                if($this->methods[$i]->{$checkField} === $checkValue)
+                if ($this->methods[$i]->{$checkField} === $checkValue)
                 {
                     continue;
                 }
@@ -235,7 +235,7 @@ 
      */
     public function getGroupByName($name, $methodName = false)
     {
-        if($methodName === false)
+        if ($methodName === false)
         {
             return $this->callOnEach('getGroupByName', array($name));
         }
@@ -255,9 +255,9 @@ 
      *
      * @return array|false An array of Auth\User objects or false if no users were found
      */
-    public function getUsersByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false, $methodName = false)
+    public function getUsersByFilter($filter, $select = false, $top = false, $skip = false, $orderby = false, $methodName = false)
     {
-        if($methodName === false)
+        if ($methodName === false)
         {
             return $this->callOnEach('getUsersByFilter', array($filter, $select, $top, $skip, $orderby), 'current');
         }
@@ -277,9 +277,9 @@ 
      *
      * @return array|false An array of Auth\PendingUser objects or false if no pending users were found
      */
-    public function getPendingUsersByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false, $methodName = false)
+    public function getPendingUsersByFilter($filter, $select = false, $top = false, $skip = false, $orderby = false, $methodName = false)
     {
-        if($methodName === false)
+        if ($methodName === false)
         {
             return $this->callOnEach('getPendingUsersByFilter', array($filter, $select, $top, $skip, $orderby), 'pending');
         }
@@ -299,9 +299,9 @@ 
      *
      * @return array|false An array of Auth\Group objects or false if no pending users were found
      */
-    public function getGroupsByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false, $methodName = false)
+    public function getGroupsByFilter($filter, $select = false, $top = false, $skip = false, $orderby = false, $methodName = false)
     {
-        if($methodName === false)
+        if ($methodName === false)
         {
             return $this->callOnEach('getGroupsByFilter', array($filter, $select, $top, $skip, $orderby), 'current');
         }
@@ -318,7 +318,7 @@ 
      */
     public function getActiveUserCount($methodName = false)
     {
-        if($methodName === false)
+        if ($methodName === false)
         {
             return $this->addFromEach('getActiveUserCount', 'current');
         }
@@ -335,7 +335,7 @@ 
      */
     public function getPendingUserCount($methodName = false)
     {
-        if($methodName === false)
+        if ($methodName === false)
         {
             return $this->addFromEach('getPendingUserCount', 'pending');
         }
@@ -352,7 +352,7 @@ 
      */
     public function getGroupCount($methodName = false)
     {
-        if($methodName === false)
+        if ($methodName === false)
         {
             return $this->addFromEach('getGroupCount', 'current');
         }
@@ -372,9 +372,9 @@ 
     {
         $ret = array();
         $count = count($this->methods);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
-            if($this->methods[$i]->supplement === false) continue;
+            if ($this->methods[$i]->supplement === false) continue;
 
             array_push($ret, $this->methods[$i]->getSupplementLink());
         }
@@ -391,7 +391,7 @@ 
      */
     public function impersonateUser($userArray)
     {
-        if(!is_object($userArray))
+        if (!is_object($userArray))
         {
             $user = new $userArray['class']($userArray);
         }
@@ -408,15 +408,15 @@ 
      */
     public function getTempUserByHash($hash, $methodName = false)
     {
-        if($methodName === false)
+        if ($methodName === false)
         {
             $count = count($this->methods);
-            for($i = 0; $i < $count; $i++)
+            for ($i = 0; $i < $count; $i++)
             {
-                if($this->methods[$i]->pending === false) continue;
+                if ($this->methods[$i]->pending === false) continue;
 
                 $ret = $this->methods[$i]->getTempUserByHash($hash);
-                if($ret !== false)
+                if ($ret !== false)
                 {
                     return $ret;
                 }
@@ -437,15 +437,15 @@ 
      */
     public function createPendingUser($user, $methodName = false)
     {
-        if($methodName === false)
+        if ($methodName === false)
         {
             $count = count($this->methods);
-            for($i = 0; $i < $count; $i++)
+            for ($i = 0; $i < $count; $i++)
             {
-                if($this->methods[$i]->pending === false) continue;
+                if ($this->methods[$i]->pending === false) continue;
 
                 $ret = $this->methods[$i]->createPendingUser($user);
-                if($ret !== false)
+                if ($ret !== false)
                 {
                     return true;
                 }
@@ -469,15 +469,15 @@ 
      */
     public function activatePendingUser($user, $methodName = false)
     {
-        if($methodName === false)
+        if ($methodName === false)
         {
             $count = count($this->methods);
-            for($i = 0; $i < $count; $i++)
+            for ($i = 0; $i < $count; $i++)
             {
-                if($this->methods[$i]->current === false) continue;
+                if ($this->methods[$i]->current === false) continue;
 
                 $ret = $this->methods[$i]->activatePendingUser($user);
-                if($ret !== false)
+                if ($ret !== false)
                 {
                     $this->impersonateUser($ret);
                     return true;
@@ -499,15 +499,15 @@ 
      */
     public function getUserByResetHash($hash, $methodName = false)
     {
-        if($methodName === false)
+        if ($methodName === false)
         {
             $count = count($this->methods);
-            for($i = 0; $i < $count; $i++)
+            for ($i = 0; $i < $count; $i++)
             {
-                if($this->methods[$i]->current === false) continue;
+                if ($this->methods[$i]->current === false) continue;
 
                 $ret = $this->methods[$i]->getUserByResetHash($hash);
-                if($ret !== false)
+                if ($ret !== false)
                 {
                     return $ret;
                 }
@@ -515,7 +515,7 @@ 
             return false;
         }
         $auth = $this->getAuthenticator($methodName);
-        if($auth === false)
+        if ($auth === false)
         {
             return $this->getUserByResetHash($hash, false);
         }
@@ -532,11 +532,11 @@ 
     public function getSuplementalProviderByHost($host)
     {
         $count = count($this->methods);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
-            if($this->methods[$i]->supplement === false) continue;
+            if ($this->methods[$i]->supplement === false) continue;
 
-            if($this->methods[$i]->getHostName() === $host)
+            if ($this->methods[$i]->getHostName() === $host)
             {
                 return $this->methods[$i];
             }
@@ -544,15 +544,15 @@ 
         return false;
     }
 
-    public function deletePendingUsersByFilter($filter, $methodName=false)
+    public function deletePendingUsersByFilter($filter, $methodName = false)
     {
         $users = $this->getPendingUsersByFilter($filter, false, false, false, false, $methodName);
-        if($users === false)
+        if ($users === false)
         {
             return false;
         }
         $count = count($users);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
             $users[$i]->delete();
         }

Braces +18 added lines, -6 removed lines

@@ -374,7 +374,9 @@ 
         $count = count($this->methods);
         for($i = 0; $i < $count; $i++)
         {
-            if($this->methods[$i]->supplement === false) continue;
+            if($this->methods[$i]->supplement === false) {
+                continue;
+            }
 
             array_push($ret, $this->methods[$i]->getSupplementLink());
         }
@@ -413,7 +415,9 @@ 
             $count = count($this->methods);
             for($i = 0; $i < $count; $i++)
             {
-                if($this->methods[$i]->pending === false) continue;
+                if($this->methods[$i]->pending === false) {
+                    continue;
+                }
 
                 $ret = $this->methods[$i]->getTempUserByHash($hash);
                 if($ret !== false)
@@ -442,7 +446,9 @@ 
             $count = count($this->methods);
             for($i = 0; $i < $count; $i++)
             {
-                if($this->methods[$i]->pending === false) continue;
+                if($this->methods[$i]->pending === false) {
+                    continue;
+                }
 
                 $ret = $this->methods[$i]->createPendingUser($user);
                 if($ret !== false)
@@ -474,7 +480,9 @@ 
             $count = count($this->methods);
             for($i = 0; $i < $count; $i++)
             {
-                if($this->methods[$i]->current === false) continue;
+                if($this->methods[$i]->current === false) {
+                    continue;
+                }
 
                 $ret = $this->methods[$i]->activatePendingUser($user);
                 if($ret !== false)
@@ -504,7 +512,9 @@ 
             $count = count($this->methods);
             for($i = 0; $i < $count; $i++)
             {
-                if($this->methods[$i]->current === false) continue;
+                if($this->methods[$i]->current === false) {
+                    continue;
+                }
 
                 $ret = $this->methods[$i]->getUserByResetHash($hash);
                 if($ret !== false)
@@ -534,7 +544,9 @@ 
         $count = count($this->methods);
         for($i = 0; $i < $count; $i++)
         {
-            if($this->methods[$i]->supplement === false) continue;
+            if($this->methods[$i]->supplement === false) {
+                continue;
+            }
 
             if($this->methods[$i]->getHostName() === $host)
             {

class.FlipAdminPage.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
         $this->addWellKnownJS(JS_METISMENU, false);
     }
 
+    /**
+     * @param string $adminGroup
+     */
     protected function userIsAdmin($adminGroup)
     {
         if($this->user === false || $this->user === null)

Spacing +20 added lines, -20 removed lines

@@ -6,13 +6,13 @@ 
     public $user;
     public $is_admin = false;
 
-    function __construct($title, $adminGroup='LDAPAdmins')
+    function __construct($title, $adminGroup = 'LDAPAdmins')
     {
         $this->user = FlipSession::getUser();
         $this->is_admin = $this->userIsAdmin($adminGroup);
         parent::__construct($title);
         $adminCSS = '/css/common/admin.min.css';
-        if($this->minified !== 'min')
+        if ($this->minified !== 'min')
         {
             $adminCSS = '/css/common/admin.css';
         }
@@ -22,7 +22,7 @@ 
 
     protected function userIsAdmin($adminGroup)
     {
-        if($this->user === false || $this->user === null)
+        if ($this->user === false || $this->user === null)
         {
             return false;
         }
@@ -31,7 +31,7 @@ 
 
     function addAllLinks()
     {
-        if($this->user === false || $this->user === null)
+        if ($this->user === false || $this->user === null)
         {
             $this->add_link('<i class="fa fa-sign-in"></i> Login', $this->loginUrl);
         }
@@ -47,13 +47,13 @@ 
         $ret  = '<li>';
         $href = $this->getHrefForDropdown($link);
         $ret .= $this->createLink($name.' <i class="fa fa-arrow-right"></i>', $href);
-        $ret.='<ul>';
+        $ret .= '<ul>';
         $subNames = array_keys($link);
-        foreach($subNames as $subName)
+        foreach ($subNames as $subName)
         {
-            $ret.=$this->getLinkByName($subName, $link);
+            $ret .= $this->getLinkByName($subName, $link);
         }
-        $ret.='</ul></li>';
+        $ret .= '</ul></li>';
         return $ret;
     }
 
@@ -62,7 +62,7 @@ 
         $sites   = $this->getSiteLinksForHeader();
         $sideNav = $this->getLinksMenus();
         $log     = '<a href="https://profiles.burningflipside.com/logout.php"><i class="fa fa-sign-out"></i></a>';
-        if($this->user === false || $this->user === null)
+        if ($this->user === false || $this->user === null)
         {
             $log = '<a href="https://profiles.burningflipside.com/login.php?return='.$this->current_url().'"><i class="fa fa-sign-in"></i></a>';
         }
@@ -108,26 +108,26 @@ 
     const CARD_YELLOW = 'panel-yellow';
     const CARD_RED    = 'panel-red';
 
-    function add_card($iconName, $bigText, $littleText, $link='#', $color = self::CARD_BLUE, $textColor=false)
+    function add_card($iconName, $bigText, $littleText, $link = '#', $color = self::CARD_BLUE, $textColor = false)
     {
-        if($textColor === false)
+        if ($textColor === false)
         {
-            switch($color)
+            switch ($color)
             {
                 default:
-                    $textColor='';
+                    $textColor = '';
                     break;
                 case self::CARD_BLUE:
-                    $textColor='text-primary';
+                    $textColor = 'text-primary';
                     break;
                 case self::CARD_GREEN:
-                    $textColor='text-success';
+                    $textColor = 'text-success';
                     break;
                 case self::CARD_YELLOW:
-                    $textColor='text-warning';
+                    $textColor = 'text-warning';
                     break;
                 case self::CARD_RED:
-                    $textColor='text-danger';
+                    $textColor = 'text-danger';
                     break;
             }
         }
@@ -156,9 +156,9 @@ 
         $this->body .= $card;
     }
 
-    function printPage($header=true)
+    function printPage($header = true)
     {
-        if($this->user === false || $this->user === null)
+        if ($this->user === false || $this->user === null)
         {
             $this->body = '
         <div class="row">
@@ -167,7 +167,7 @@ 
             </div>
         </div>';
         }
-        else if($this->is_admin === false)
+        else if ($this->is_admin === false)
         {
             $this->body = '
         <div class="row">

Braces +2 added lines, -4 removed lines

@@ -34,8 +34,7 @@ 
         if($this->user === false || $this->user === null)
         {
             $this->add_link('<i class="fa fa-sign-in"></i> Login', $this->loginUrl);
-        }
-        else
+        } else
         {
             $this->add_links();
             $this->add_link('<i class="fa fa-sign-out"></i> Logout', $this->logoutUrl);
@@ -166,8 +165,7 @@ 
                 <h1 class="page-header">You must <a href="'.$this->loginUrl.'?return='.$this->current_url().'">log in <span class="glyphicon glyphicon-log-in"></span></a> to access the '.$this->title.' Admin system!</h1>
             </div>
         </div>';
-        }
-        else if($this->is_admin === false)
+        } else if($this->is_admin === false)
         {
             $this->body = '
         <div class="row">