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

@@ -14,7 +14,7 @@ 
 namespace Auth;
 
 /** We need the FlipsideSettings class to determine how to connect to the LDAP server */
-if(isset($GLOBALS['FLIPSIDE_SETTINGS_LOC']))
+if (isset($GLOBALS['FLIPSIDE_SETTINGS_LOC']))
 {
     require_once($GLOBALS['FLIPSIDE_SETTINGS_LOC'].'/class.FlipsideSettings.php');
 }
@@ -33,18 +33,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;
             }
         }
@@ -92,7 +92,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');
     }
 
@@ -107,11 +107,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'];
         }
@@ -130,17 +130,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];
         }
@@ -156,13 +156,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();
         }
@@ -170,7 +170,7 @@ 
         {
             $ret = $server->bind($this->bind_dn, $this->bind_pass);
         }
-        if($ret === false)
+        if ($ret === false)
         {
             return false;
         }
@@ -188,20 +188,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); 
         }
@@ -217,7 +217,7 @@ 
      */
     public function isLoggedIn($data)
     {
-        if(isset($data['res']))
+        if (isset($data['res']))
         {
             return $data['res'];
         }
@@ -239,35 +239,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));
@@ -279,7 +279,7 @@ 
     public function getActiveUserCount()
     {
         $server = $this->get_and_bind_server();
-        if($server === false)
+        if ($server === false)
         {
             return false;
         }
@@ -288,50 +288,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);
@@ -349,36 +349,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!');
         }
@@ -388,7 +388,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;
         }

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

@@ -9,11 +9,11 @@ 
         {
             return $this->server->update($obj);
         }
-        catch(\Exception $ex)
+        catch (\Exception $ex)
         {
             $auth = \AuthProvider::getInstance();
             $ldap = $auth->getAuthenticator('Auth\LDAPAuthenticator');
-            if($ldap === false) return false;
+            if ($ldap === false) return false;
             $this->server = $ldap->get_and_bind_server(true);
             return $this->server->update($obj);
         }
@@ -21,7 +21,7 @@ 
 
     protected function getField($fieldName)
     {
-        if(!is_object($this->ldapObj))
+        if (!is_object($this->ldapObj))
         {
             return $this->getFieldLocal($fieldName);
         }
@@ -30,7 +30,7 @@ 
 
     protected function getFieldSingleValue($fieldName)
     {
-        if(!is_object($this->ldapObj))
+        if (!is_object($this->ldapObj))
         {
             return $this->getFieldLocalSingleValue($fieldName);
         }
@@ -39,7 +39,7 @@ 
 
     protected function setField($fieldName, $fieldValue)
     {
-        if(!is_object($this->ldapObj))
+        if (!is_object($this->ldapObj))
         {
             return $this->setFieldLocal($fieldName, $fieldValue);
         }
@@ -48,7 +48,7 @@ 
 
     protected function appendField($fieldName, $fieldValue)
     {
-        if(!is_object($this->ldapObj))
+        if (!is_object($this->ldapObj))
         {
             return $this->appendFieldLocal($fieldName, $fieldValue);
         }
@@ -57,11 +57,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;
         }
@@ -71,7 +71,7 @@ 
     private function getFieldServer($fieldName)
     {
         $lowerName = strtolower($fieldName);
-        if(!isset($this->ldapObj->{$lowerName}))
+        if (!isset($this->ldapObj->{$lowerName}))
         {
             return false;
         }
@@ -80,15 +80,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];
         }
@@ -98,12 +98,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;
         }
@@ -113,7 +113,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;
         }
@@ -129,7 +129,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;
@@ -144,13 +144,13 @@ 
 
     private function setFieldLocal($fieldName, $fieldValue)
     {
-        if($this->ldapObj === false)
+        if ($this->ldapObj === false)
         {
             $this->ldapObj = array();
         }
-        if($fieldValue === null || (is_string($fieldValue) && strlen($fieldValue) === 0))
+        if ($fieldValue === null || (is_string($fieldValue) && strlen($fieldValue) === 0))
         {
-            if(isset($this->ldapObj[$fieldName]))
+            if (isset($this->ldapObj[$fieldName]))
             {
                 unset($this->ldapObj[$fieldName]);
             }
@@ -162,11 +162,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();
         }

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!');
         }

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

Spacing +49 added lines, -49 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::getDataSetByName($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::getDataSetByName($this->params['pending_data_set']);
         }
         return \DataSetFactory::getDataSetByName('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);
-        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]);
         }
@@ -166,7 +166,7 @@ 
 
     public function isLoggedIn($data)
     {
-        if(isset($data['res']))
+        if (isset($data['res']))
         {
             return $data['res'];
         }
@@ -175,7 +175,7 @@ 
 
     public function getUser($data)
     {
-        if(isset($this->params['current_data_set']))
+        if (isset($this->params['current_data_set']))
         {
             $data['current_data_set'] = $this->params['current_data_set'];
         }
@@ -187,7 +187,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;
         }
@@ -199,7 +199,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;
         }
@@ -215,33 +215,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();
     }
 
@@ -249,26 +249,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);
             }
@@ -276,22 +276,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);
         }
@@ -300,9 +300,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);
         }
@@ -310,10 +310,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!');
             }
@@ -325,7 +325,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;
         }

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);
         }

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

@@ -18,7 +18,7 @@ 
 /**
  * Require the FlipsideSettings file
  */
-if(isset($GLOBALS['FLIPSIDE_SETTINGS_LOC']))
+if (isset($GLOBALS['FLIPSIDE_SETTINGS_LOC']))
 {
     require_once($GLOBALS['FLIPSIDE_SETTINGS_LOC'].'/class.FlipsideSettings.php');
 }
@@ -43,11 +43,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]]));
@@ -65,9 +65,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];
             }
@@ -89,10 +89,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);
             }
@@ -112,10 +112,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);
@@ -163,11 +163,11 @@ 
      */
     private function mergeResult(&$returnValue, $res)
     {
-        if($res === false)
+        if ($res === false)
         {
             return;
         }
-        if($returnValue === false)
+        if ($returnValue === false)
         {
             $returnValue = $res;
             return;
@@ -189,11 +189,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;
                 }
@@ -217,11 +217,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;
                 }
@@ -242,7 +242,7 @@ 
      */
     public function getGroupByName($name, $methodName = false)
     {
-        if($methodName === false)
+        if ($methodName === false)
         {
             return $this->callOnEach('getGroupByName', array($name));
         }
@@ -262,9 +262,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');
         }
@@ -284,9 +284,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');
         }
@@ -306,9 +306,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');
         }
@@ -325,7 +325,7 @@ 
      */
     public function getActiveUserCount($methodName = false)
     {
-        if($methodName === false)
+        if ($methodName === false)
         {
             return $this->addFromEach('getActiveUserCount', 'current');
         }
@@ -342,7 +342,7 @@ 
      */
     public function getPendingUserCount($methodName = false)
     {
-        if($methodName === false)
+        if ($methodName === false)
         {
             return $this->addFromEach('getPendingUserCount', 'pending');
         }
@@ -359,7 +359,7 @@ 
      */
     public function getGroupCount($methodName = false)
     {
-        if($methodName === false)
+        if ($methodName === false)
         {
             return $this->addFromEach('getGroupCount', 'current');
         }
@@ -379,9 +379,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());
         }
@@ -398,7 +398,7 @@ 
      */
     public function impersonateUser($userArray)
     {
-        if(!is_object($userArray))
+        if (!is_object($userArray))
         {
             $user = new $userArray['class']($userArray);
         }
@@ -415,15 +415,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;
                 }
@@ -444,15 +444,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;
                 }
@@ -476,15 +476,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;
@@ -506,15 +506,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;
                 }
@@ -522,7 +522,7 @@ 
             return false;
         }
         $auth = $this->getAuthenticator($methodName);
-        if($auth === false)
+        if ($auth === false)
         {
             return $this->getUserByResetHash($hash, false);
         }
@@ -539,11 +539,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];
             }
@@ -551,32 +551,32 @@ 
         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();
         }
         return true;
     }
 
-    public function getUserByAccessCode($key, $methodName=false)
+    public function getUserByAccessCode($key, $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]->getUserByAccessCode($key);
-                if($ret !== false)
+                if ($ret !== false)
                 {
                     return $ret;
                 }

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 +13 added lines, -13 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->addLink('<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->currentUrl().'"><i class="fa fa-sign-in"></i></a>';
         }
@@ -108,7 +108,7 @@ 
     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)
     {
         $card = '<div class="col-lg-3 col-md-6">
                      <div class="panel '.$color.'">
@@ -135,9 +135,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">
@@ -146,7 +146,7 @@ 
             </div>
         </div>';
         }
-        else if($this->is_admin === false)
+        else if ($this->is_admin === false)
         {
             $this->body = '
         <div class="row">

class.FlipPage.php

Doc Comments +10 added lines, -6 removed lines

@@ -487,7 +487,6 @@ 
     /**
      * Add a Cascading Style Sheet file from its src URI
      *
-     * @param string $src The webpath to the Cascading Style Sheet file
      * @param boolean $async Can the CSS be loaded asynchronously?
      */
     public function addCSSByURI($uri, $async=false)
@@ -514,6 +513,9 @@ 
         $this->addWellKnownJS($type, $async);
     }
 
+    /**
+     * @param integer $type
+     */
     function add_js($type, $async=true)
     {
         $this->addWellKnownJS($type, $async);
@@ -582,6 +584,9 @@ 
         return $ret;
     }
 
+    /**
+     * @return string
+     */
     protected function getHrefForDropdown(&$link)
     {
         if(isset($link['_']))
@@ -685,7 +690,7 @@ 
      *
      * @param string $msg The message to show in the notifcation
      * @param string $sev The severity of the notifcation
-     * @param boolean $dismissible Can the user dismiss the notificaton?
+     * @param integer $dismissible Can the user dismiss the notificaton?
      *
      * @deprecated 2.0.0 Use the addNotification function instead 
      */
@@ -699,7 +704,7 @@ 
      * Add a notification to the page
      *
      * @param string $message The message to show in the notifcation
-     * @param string $sevity The severity of the notifcation
+     * @param string $severity The severity of the notifcation
      * @param boolean $dismissible Can the user dismiss the notificaton?
      *
      * @deprecated 2.0.0 Use the addNotification function instead
@@ -793,7 +798,6 @@ 
      * Draw the page
      *
      * @param boolean $header Draw the header
-     * @param boolean $analytics Include analytics on the page
      */
     public function printPage($header=true)
     {
@@ -812,7 +816,7 @@ 
      *
      * @param string $name The name of the link
      * @param false|string $url The URL to link to
-     * @param false|array $subment Any submenu items for the dropdown
+     * @param false|array $submenu Any submenu items for the dropdown
      *
      * @deprecated 1.0.0 Use addLink instead
      */
@@ -826,7 +830,7 @@ 
      *
      * @param string $name The name of the link
      * @param false|string $url The URL to link to
-     * @param false|array $subment Any submenu items for the dropdown
+     * @param false|array $submenu Any submenu items for the dropdown
      */
     public function addLink($name, $url=false, $submenu=false)
     {

Spacing +73 added lines, -73 removed lines

@@ -16,7 +16,7 @@ 
  * We use the FlipsideSettings class for a list of sites and settings
  * about CDNs and minified JS/CSS
  */
-if(isset($GLOBALS['FLIPSIDE_SETTINGS_LOC']))
+if (isset($GLOBALS['FLIPSIDE_SETTINGS_LOC']))
 {
     require_once($GLOBALS['FLIPSIDE_SETTINGS_LOC'].'/class.FlipsideSettings.php');
 }
@@ -30,32 +30,32 @@ 
  */
 require_once('class.WebPage.php');
 
-define('JS_JQUERY',       0);
-define('JS_JQUERY_UI',    1);
-define('JS_BOOTSTRAP',    2);
+define('JS_JQUERY', 0);
+define('JS_JQUERY_UI', 1);
+define('JS_BOOTSTRAP', 2);
 define('JQUERY_VALIDATE', 3);
-define('JQUERY_TOUCH',    4);
-define('JS_TINYNAV',      5);
+define('JQUERY_TOUCH', 4);
+define('JS_TINYNAV', 5);
 define('JS_BOOTSTRAP_FH', 6);
 define('JS_BOOTSTRAP_SW', 7);
-define('JS_DATATABLE',    8);
-define('JS_CHART',        9);
-define('JS_METISMENU',    10);
-define('JS_BOOTBOX',         11);
+define('JS_DATATABLE', 8);
+define('JS_CHART', 9);
+define('JS_METISMENU', 10);
+define('JS_BOOTBOX', 11);
 define('JS_DATATABLE_ODATA', 12);
-define('JS_CRYPTO_MD5_JS',   13);
-define('JS_JCROP',           14);
-define('JS_TYPEAHEAD',       15);
-define('JS_FLIPSIDE',     20);
-define('JS_LOGIN',        21);
-
-define('CSS_JQUERY_UI',    0);
-define('CSS_BOOTSTRAP',    1);
+define('JS_CRYPTO_MD5_JS', 13);
+define('JS_JCROP', 14);
+define('JS_TYPEAHEAD', 15);
+define('JS_FLIPSIDE', 20);
+define('JS_LOGIN', 21);
+
+define('CSS_JQUERY_UI', 0);
+define('CSS_BOOTSTRAP', 1);
 define('CSS_BOOTSTRAP_FH', 2);
 define('CSS_BOOTSTRAP_SW', 3);
-define('CSS_DATATABLE',    4);
-define('CSS_JCROP',        5);
-define('CSS_FONTAWESOME',  6);
+define('CSS_DATATABLE', 4);
+define('CSS_JCROP', 5);
+define('CSS_FONTAWESOME', 6);
 
 global $jsArray;
 $jsArray = array(
@@ -349,7 +349,7 @@ 
      *
      * @SuppressWarnings("StaticAccess")
      */
-    function __construct($title, $header=true)
+    function __construct($title, $header = true)
     {
         parent::__construct($title);
         $this->setupVars();
@@ -361,13 +361,13 @@ 
         $this->notifications = array();
         $this->loginUrl = 'login.php';
         $this->logoutUrl = 'logout.php';
-        if(isset(FlipsideSettings::$global))
+        if (isset(FlipsideSettings::$global))
         {
-            if(isset(FlipsideSettings::$global['login_url']))
+            if (isset(FlipsideSettings::$global['login_url']))
             {
                 $this->loginUrl = FlipsideSettings::$global['login_url'];
             }
-            if(isset(FlipsideSettings::$global['logout_url']))
+            if (isset(FlipsideSettings::$global['logout_url']))
             {
                 $this->logoutUrl = FlipsideSettings::$global['logout_url'];
             }
@@ -382,7 +382,7 @@ 
      */
     protected function getSites()
     {
-        if(isset(FlipsideSettings::$sites))
+        if (isset(FlipsideSettings::$sites))
         {
             return FlipsideSettings::$sites;
         }
@@ -398,9 +398,9 @@ 
      */
     protected function addAllLinks()
     {
-        if($this->user === false || $this->user === null)
+        if ($this->user === false || $this->user === null)
         {
-            if(isset($_SERVER['REQUEST_URI']) && strstr($_SERVER['REQUEST_URI'], 'logout.php') === false)
+            if (isset($_SERVER['REQUEST_URI']) && strstr($_SERVER['REQUEST_URI'], 'logout.php') === false)
             {
                 $this->addLink('Login', $this->loginUrl);
             }
@@ -423,16 +423,16 @@ 
      */
     private function setupVars()
     {
-        if($this->minified !== null && $this->cdn !== null) return;
+        if ($this->minified !== null && $this->cdn !== null) return;
         $this->minified = 'min';
         $this->cdn      = 'cdn';
-        if(isset(FlipsideSettings::$global))
+        if (isset(FlipsideSettings::$global))
         {
-            if(isset(FlipsideSettings::$global['use_minified']) && !FlipsideSettings::$global['use_minified'])
+            if (isset(FlipsideSettings::$global['use_minified']) && !FlipsideSettings::$global['use_minified'])
             {
                 $this->minified = 'no';
             }
-            if(isset(FlipsideSettings::$global['use_cdn']) && !FlipsideSettings::$global['use_cdn'])
+            if (isset(FlipsideSettings::$global['use_cdn']) && !FlipsideSettings::$global['use_cdn'])
             {
                 $this->cdn = 'no';
             }
@@ -447,7 +447,7 @@ 
      *
      * @deprecated 2.0.0 Please use addJSByURI() instead
      */
-    function add_js_from_src($src, $async=true)
+    function add_js_from_src($src, $async = true)
     {
         $this->addJSByURI($src, $async);
     }
@@ -458,10 +458,10 @@ 
      * @param string $uri The webpath to the JavaScript file
      * @param boolean $async Can the JavaScript be loaded asynchronously?
      */
-    public function addJSByURI($uri, $async=true)
+    public function addJSByURI($uri, $async = true)
     {
         $attributes = array('src'=>$uri, 'type'=>'text/javascript');
-        if($async === true)
+        if ($async === true)
         {
             $attributes['async'] = true;
         }
@@ -479,7 +479,7 @@ 
      *
      * @deprecated 2.0.0 Please use addCSSByURI() instead
      */
-    function add_css_from_src($src, $import=false)
+    function add_css_from_src($src, $import = false)
     {
         $this->addCSSByURI($src, $import);
     }
@@ -490,10 +490,10 @@ 
      * @param string $src The webpath to the Cascading Style Sheet file
      * @param boolean $async Can the CSS be loaded asynchronously?
      */
-    public function addCSSByURI($uri, $async=false)
+    public function addCSSByURI($uri, $async = false)
     {
         $attributes = array('rel'=>'stylesheet', 'href'=>$uri, 'type'=>'text/css');
-        if($async === true && $this->importSupport === true)
+        if ($async === true && $this->importSupport === true)
         {
             $attributes['rel'] = 'import';
         }
@@ -509,12 +509,12 @@ 
      *
      * @deprecated 2.0.0 Please use addWellKnownJS() instead
      */
-    function addJS($type, $async=true)
+    function addJS($type, $async = true)
     {
         $this->addWellKnownJS($type, $async);
     }
 
-    function add_js($type, $async=true)
+    function add_js($type, $async = true)
     {
         $this->addWellKnownJS($type, $async);
     }
@@ -525,7 +525,7 @@ 
      * @param string $jsFileID the ID of the JS file
      * @param boolean $async Can the JS file be loaded asynchronously?
      */
-    public function addWellKnownJS($jsFileID, $async=true)
+    public function addWellKnownJS($jsFileID, $async = true)
     {
         global $jsArray;
         $this->setupVars();
@@ -541,7 +541,7 @@ 
      *
      * @deprecated 2.0.0 Please use addWellKnownCSS() instead
      */
-    function add_css($type, $import=false)
+    function add_css($type, $import = false)
     {
         $this->addWellKnownCSS($type, $import);
     }
@@ -552,7 +552,7 @@ 
      * @param string $cssFileID the ID of the CSS file
      * @param boolean $async Can the CSS file be loaded asynchronously?
      */
-    public function addWellKnownCSS($cssFileID, $async=true)
+    public function addWellKnownCSS($cssFileID, $async = true)
     {
         global $cssArray;
         $this->setupVars();
@@ -575,16 +575,16 @@ 
         $sites = $this->getSites();
         $names = array_keys($sites);
         $ret = '';
-        foreach($names as $name)
+        foreach ($names as $name)
         {
-            $ret.='<li>'.$this->createLink($name, $sites[$name]).'</li>';
+            $ret .= '<li>'.$this->createLink($name, $sites[$name]).'</li>';
         }
         return $ret;
     }
 
     protected function getHrefForDropdown(&$link)
     {
-        if(isset($link['_']))
+        if (isset($link['_']))
         {
             $ret = $link['_'];
             unset($link['_']);
@@ -597,24 +597,24 @@ 
     {
         $ret = '<li class="dropdown">';
         $href = $this->getHrefForDropdown($link);
-        $ret.= '<a href="'.$href.'" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">'.$name.' <span class="caret"></span></a>';
-        $ret.='<ul class="dropdown-menu">';
+        $ret .= '<a href="'.$href.'" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">'.$name.' <span class="caret"></span></a>';
+        $ret .= '<ul class="dropdown-menu">';
         $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;
     }
 
     protected function getLinkByName($name, $links)
     {
-        if(is_array($links[$name]))
+        if (is_array($links[$name]))
         {
             return $this->getDropdown($links[$name], $name);
         }
-        if($links[$name] === false)
+        if ($links[$name] === false)
         {
             return '<li>'.$name.'</li>';
         }
@@ -625,9 +625,9 @@ 
     {
         $names = array_keys($this->links);
         $ret = '';
-        foreach($names as $name)
+        foreach ($names as $name)
         {
-            $ret.=$this->getLinkByName($name, $this->links);
+            $ret .= $this->getLinkByName($name, $this->links);
         }
         return $ret;
     }
@@ -639,7 +639,7 @@ 
     {
         $sites = $this->getSiteLinksForHeader();
         $links = $this->getLinksMenus();
-        $header ='<nav class="navbar navbar-default navbar-fixed-top">
+        $header = '<nav class="navbar navbar-default navbar-fixed-top">
                       <div class="container-fluid">
                           <!-- Brand and toggle get grouped for better mobile display -->
                           <div class="navbar-header">
@@ -668,7 +668,7 @@ 
                       </div>
                   </nav>';
         $this->body = $header.$this->body;
-        $this->body_tags.='style="padding-top: 60px;"';
+        $this->body_tags .= 'style="padding-top: 60px;"';
     }
 
     /** Notification that is green for success */
@@ -689,7 +689,7 @@ 
      *
      * @deprecated 2.0.0 Use the addNotification function instead 
      */
-    function add_notification($msg, $sev=self::NOTIFICATION_INFO, $dismissible=1)
+    function add_notification($msg, $sev = self::NOTIFICATION_INFO, $dismissible = 1)
     {
         $notice = array('msg'=>$msg, 'sev'=>$sev, 'dismissible'=>$dismissible);
         array_push($this->notifications, $notice);
@@ -704,7 +704,7 @@ 
      *
      * @deprecated 2.0.0 Use the addNotification function instead
      */
-    public function addNotification($message, $severity=self::NOTIFICATION_INFO, $dismissible=true)
+    public function addNotification($message, $severity = self::NOTIFICATION_INFO, $dismissible = true)
     {
         array_push($this->notificatons, array('msg'=>$message, 'sev'=>$severity, 'dismissible'=>$dismissible)); 
     }
@@ -715,21 +715,21 @@ 
     private function renderNotifications()
     {
         $count = count($this->notifications);
-        if($count === 0)
+        if ($count === 0)
         {
             return;
         }
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
             $class = 'alert '.$this->notifications[$i]['sev'];
             $button = '';
-            if($this->notifications[$i]['dismissible'])
+            if ($this->notifications[$i]['dismissible'])
             {
                 $class .= ' alert-dismissible';
                 $button = '<button type="button" class="close" data-dismiss="alert"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>';
             }
             $prefix = '';
-            switch($this->notifications[$i]['sev'])
+            switch ($this->notifications[$i]['sev'])
             {
                 case self::NOTIFICATION_INFO:
                     $prefix = '<strong>Notice:</strong> '; 
@@ -742,10 +742,10 @@ 
                     break;
             }
             $style = '';
-            if($i+1 < count($this->notifications))
+            if ($i + 1 < count($this->notifications))
             {
                 //Not the last notification, remove the end margin
-                $style='style="margin: 0px;"';
+                $style = 'style="margin: 0px;"';
             }
             $this->body = '
                 <div class="'.$class.'" role="alert" '.$style.'>
@@ -773,7 +773,7 @@ 
      */
     private function addAnalyticsBlock()
     {
-        if($this->analytics === false)
+        if ($this->analytics === false)
         {
             return;
         }
@@ -795,12 +795,12 @@ 
      * @param boolean $header Draw the header
      * @param boolean $analytics Include analytics on the page
      */
-    public function printPage($header=true)
+    public function printPage($header = true)
     {
         $this->renderNotifications();
         $this->addNoScript();
         $this->addAnalyticsBlock();
-        if($this->header || $header)
+        if ($this->header || $header)
         {
             $this->addHeader();
         }
@@ -816,7 +816,7 @@ 
      *
      * @deprecated 1.0.0 Use addLink instead
      */
-    function add_link($name, $url=false, $submenu=false)
+    function add_link($name, $url = false, $submenu = false)
     {
         $this->addLink($name, $url, $submenu);
     }
@@ -828,9 +828,9 @@ 
      * @param false|string $url The URL to link to
      * @param false|array $subment Any submenu items for the dropdown
      */
-    public function addLink($name, $url=false, $submenu=false)
+    public function addLink($name, $url = false, $submenu = false)
     {
-        if(is_array($submenu))
+        if (is_array($submenu))
         {
             $submenu['_'] = $url;
             $this->links[$name] = $submenu;
@@ -852,11 +852,11 @@ 
         $authLinks = $auth->getSupplementaryLinks();
         $authLinksStr = '';
         $count = count($authLinks);
-        for($i = 0; $i < $count; $i++)
+        for ($i = 0; $i < $count; $i++)
         {
             $authLinksStr .= $authLinks[$i];
         }
-        if($count > 0)
+        if ($count > 0)
         {
             $authLinksStr = 'Sign in with '.$authLinksStr;
         }