AgelxNash / DocLister

assets/lib/MODxAPI/modUsers.php

Doc Comments +1 added lines, -1 removed lines

@@ -501,7 +501,7 @@
     }
 
     /**
-     * @param $cookieName
+     * @param string $cookieName
      * @param bool $remember
      * @return $this
      */

Spacing +17 added lines, -17 removed lines

@@ -95,7 +95,7 @@ 
             $this->close();
             $this->newDoc = false;
 
-            if (!$find = $this->findUser($id)) {
+            if ( ! $find = $this->findUser($id)) {
                 $this->id = null;
             } else {
                 $result = $this->query("
@@ -122,7 +122,7 @@ 
      */
     public function set($key, $value)
     {
-        if (is_scalar($value) && is_scalar($key) && !empty($key)) {
+        if (is_scalar($value) && is_scalar($key) && ! empty($key)) {
             switch ($key) {
                 case 'password':
                     $this->givenPassword = $value;
@@ -162,14 +162,14 @@ 
             return false;
         }
 
-        if (!$this->checkUnique('web_users', 'username')) {
+        if ( ! $this->checkUnique('web_users', 'username')) {
             $this->log['UniqueUsername'] = 'username not unique <pre>' . print_r($this->get('username'),
                     true) . '</pre>';
 
             return false;
         }
 
-        if (!$this->checkUnique('web_user_attributes', 'email', 'internalKey')) {
+        if ( ! $this->checkUnique('web_user_attributes', 'email', 'internalKey')) {
             $this->log['UniqueEmail'] = 'Email not unique <pre>' . print_r($this->get('email'), true) . '</pre>';
 
             return false;
@@ -178,13 +178,13 @@ 
         $fld = $this->toArray();
         foreach ($this->default_field['user'] as $key => $value) {
             $tmp = $this->get($key);
-            if ($this->newDoc && (!is_int($tmp) && $tmp == '')) {
+            if ($this->newDoc && ( ! is_int($tmp) && $tmp == '')) {
                 $this->field[$key] = $value;
             }
             $this->Uset($key, 'user');
             unset($fld[$key]);
         }
-        if (!empty($this->set['user'])) {
+        if ( ! empty($this->set['user'])) {
             if ($this->newDoc) {
                 $SQL = "INSERT into {$this->makeTable('web_users')} SET " . implode(', ', $this->set['user']);
             } else {
@@ -200,13 +200,13 @@ 
 
         foreach ($this->default_field['attribute'] as $key => $value) {
             $tmp = $this->get($key);
-            if ($this->newDoc && (!is_int($tmp) && $tmp == '')) {
+            if ($this->newDoc && ( ! is_int($tmp) && $tmp == '')) {
                 $this->field[$key] = $value;
             }
             $this->Uset($key, 'attribute');
             unset($fld[$key]);
         }
-        if (!empty($this->set['attribute'])) {
+        if ( ! empty($this->set['attribute'])) {
             if ($this->newDoc) {
                 $this->set('internalKey', $this->id)->Uset('internalKey', 'attribute');
                 $SQL = "INSERT into {$this->makeTable('web_user_attributes')} SET " . implode(', ',
@@ -219,7 +219,7 @@ 
         }
         unset($fld['id']);
         foreach ($fld as $key => $value) {
-            if ($value == '' || !$this->isChanged($key)) {
+            if ($value == '' || ! $this->isChanged($key)) {
                 continue;
             }
             $result = $this->query("SELECT `setting_value` FROM {$this->makeTable('web_user_settings')} WHERE `webuser` = '{$this->id}' AND `setting_name` = '{$key}'");
@@ -229,7 +229,7 @@ 
                 $this->query("INSERT into {$this->makeTable('web_user_settings')} SET `webuser` = {$this->id},`setting_name` = '{$key}',`setting_value` = '{$value}';");
             }
         }
-        if (!$this->newDoc && $this->givenPassword) {
+        if ( ! $this->newDoc && $this->givenPassword) {
             $this->invokeEvent('OnWebChangePassword', array(
                 'userObj'      => $this,
                 'userid'       => $this->id,
@@ -329,7 +329,7 @@ 
         $b = $tmp->get('blocked');
         $bu = $tmp->get('blockeduntil');
         $ba = $tmp->get('blockedafter');
-        $flag = (($b && !$bu && !$ba) || ($bu && $now < $bu) || ($ba && $now > $ba));
+        $flag = (($b && ! $bu && ! $ba) || ($bu && $now < $bu) || ($ba && $now > $ba));
         unset($tmp);
 
         return $flag;
@@ -351,7 +351,7 @@ 
 
         $flag = $pluginFlag = false;
         if (
-            (null !== $tmp->getID()) && (!$blocker || ($blocker && !$tmp->checkBlock($id)))
+            (null !== $tmp->getID()) && ( ! $blocker || ($blocker && ! $tmp->checkBlock($id)))
         ) {
             $eventResult = $this->getInvokeEventResult('OnWebAuthentication', array(
                 'userObj'       => $this,
@@ -367,7 +367,7 @@ 
             } else {
                 $pluginFlag = (bool)$eventResult;
             }
-            if (!$pluginFlag) {
+            if ( ! $pluginFlag) {
                 $flag = ($tmp->get('password') == $tmp->getPassword($password));
             }
         }
@@ -395,7 +395,7 @@ 
                     && null !== $this->getID() 
                     && $this->get('password') == $cookie[1] 
                     && $this->get('sessionid') == $cookie[2] 
-                    && !$this->checkBlock($this->getID())
+                    && ! $this->checkBlock($this->getID())
                 ) {
                     $flag = $this->authUser($this->getID(), $fulltime, $cookieName, $fire_events);
 
@@ -412,7 +412,7 @@ 
      */
     public function logOut($cookieName = 'WebLoginPE', $fire_events = null)
     {
-        if (!$uid = $this->modx->getLoginUserID('web')) {
+        if ( ! $uid = $this->modx->getLoginUserID('web')) {
             return;
         }
         $params = array(
@@ -507,7 +507,7 @@ 
      */
     public function setAutoLoginCookie($cookieName, $remember = true)
     {
-        if (!empty($cookieName) && $this->getID()) {
+        if ( ! empty($cookieName) && $this->getID()) {
             $secure = $this->isSecure();
             $remember = is_bool($remember) ? (60 * 60 * 24 * 365 * 5) : (int)$remember;
             $cookieValue = array(md5($this->get('username')), $this->get('password'), $this->get('sessionid'), $remember);
@@ -571,7 +571,7 @@ 
      */
     public function setUserGroups($userID = 0, $groupIds = array())
     {
-        if (!is_array($groupIds)) return $this;
+        if ( ! is_array($groupIds)) return $this;
         if ($this->newDoc && $userID == 0) {
             $this->groupIds = $groupIds;
         } else {

Braces +98 added lines, -94 removed lines

@@ -4,8 +4,8 @@ 
 /**
  * Class modUsers
  */
-class modUsers extends MODxAPI
-{
+class modUsers extends MODxAPI

+{

     /**
      * @var array
      */
@@ -55,8 +55,8 @@ 
      * @param $key
      * @return bool
      */
-    public function issetField($key)
-    {
+    public function issetField($key)

+    {

         return (array_key_exists($key, $this->default_field['user']) || array_key_exists($key,
                 $this->default_field['attribute']) || in_array($key, $this->default_field['hidden']));
     }
@@ -65,9 +65,9 @@ 
      * @param string $data
      * @return string|false
      */
-    protected function findUser($data)
-    {
-        switch (true) {
+    protected function findUser($data)

+    {

+        switch (true) {

             case (is_int($data) || ((int)$data > 0 && (string)intval($data) === $data)):
                 $find = 'attribute.internalKey';
                 break;
@@ -88,16 +88,16 @@ 
      * @param $id
      * @return $this
      */
-    public function edit($id)
-    {
+    public function edit($id)

+    {

         $id = is_scalar($id) ? trim($id) : '';
-        if ($this->getID() != $id) {
+        if ($this->getID() != $id) {

             $this->close();
             $this->newDoc = false;
 
-            if (!$find = $this->findUser($id)) {
+            if (!$find = $this->findUser($id)) {

                 $this->id = null;
-            } else {
+            } else {

                 $result = $this->query("
                     SELECT * from {$this->makeTable('web_user_attributes')} as attribute
                     LEFT JOIN {$this->makeTable('web_users')} as user ON user.id=attribute.internalKey
@@ -120,10 +120,10 @@ 
      * @param $value
      * @return $this
      */
-    public function set($key, $value)
-    {
-        if (is_scalar($value) && is_scalar($key) && !empty($key)) {
-            switch ($key) {
+    public function set($key, $value)

+    {

+        if (is_scalar($value) && is_scalar($key) && !empty($key)) {

+            switch ($key) {

                 case 'password':
                     $this->givenPassword = $value;
                     $value = $this->getPassword($value);
@@ -143,8 +143,8 @@ 
      * @param $pass
      * @return string
      */
-    public function getPassword($pass)
-    {
+    public function getPassword($pass)

+    {

         return md5($pass);
     }
 
@@ -153,83 +153,83 @@ 
      * @param bool $clearCache
      * @return bool|int|null|void
      */
-    public function save($fire_events = false, $clearCache = false)
-    {
-        if ($this->get('email') == '' || $this->get('username') == '' || $this->get('password') == '') {
+    public function save($fire_events = false, $clearCache = false)

+    {

+        if ($this->get('email') == '' || $this->get('username') == '' || $this->get('password') == '') {

             $this->log['EmptyPKField'] = 'Email, username or password is empty <pre>' . print_r($this->toArray(),
                     true) . '</pre>';
 
             return false;
         }
 
-        if (!$this->checkUnique('web_users', 'username')) {
+        if (!$this->checkUnique('web_users', 'username')) {

             $this->log['UniqueUsername'] = 'username not unique <pre>' . print_r($this->get('username'),
                     true) . '</pre>';
 
             return false;
         }
 
-        if (!$this->checkUnique('web_user_attributes', 'email', 'internalKey')) {
+        if (!$this->checkUnique('web_user_attributes', 'email', 'internalKey')) {

             $this->log['UniqueEmail'] = 'Email not unique <pre>' . print_r($this->get('email'), true) . '</pre>';
 
             return false;
         }
         $this->set('sessionid', '');
         $fld = $this->toArray();
-        foreach ($this->default_field['user'] as $key => $value) {
+        foreach ($this->default_field['user'] as $key => $value) {

             $tmp = $this->get($key);
-            if ($this->newDoc && (!is_int($tmp) && $tmp == '')) {
+            if ($this->newDoc && (!is_int($tmp) && $tmp == '')) {

                 $this->field[$key] = $value;
             }
             $this->Uset($key, 'user');
             unset($fld[$key]);
         }
-        if (!empty($this->set['user'])) {
-            if ($this->newDoc) {
+        if (!empty($this->set['user'])) {

+            if ($this->newDoc) {

                 $SQL = "INSERT into {$this->makeTable('web_users')} SET " . implode(', ', $this->set['user']);
-            } else {
+            } else {

                 $SQL = "UPDATE {$this->makeTable('web_users')} SET " . implode(', ',
                         $this->set['user']) . " WHERE id = " . $this->id;
             }
             $this->query($SQL);
         }
 
-        if ($this->newDoc) {
+        if ($this->newDoc) {

             $this->id = $this->modx->db->getInsertId();
         }
 
-        foreach ($this->default_field['attribute'] as $key => $value) {
+        foreach ($this->default_field['attribute'] as $key => $value) {

             $tmp = $this->get($key);
-            if ($this->newDoc && (!is_int($tmp) && $tmp == '')) {
+            if ($this->newDoc && (!is_int($tmp) && $tmp == '')) {

                 $this->field[$key] = $value;
             }
             $this->Uset($key, 'attribute');
             unset($fld[$key]);
         }
-        if (!empty($this->set['attribute'])) {
-            if ($this->newDoc) {
+        if (!empty($this->set['attribute'])) {

+            if ($this->newDoc) {

                 $this->set('internalKey', $this->id)->Uset('internalKey', 'attribute');
                 $SQL = "INSERT into {$this->makeTable('web_user_attributes')} SET " . implode(', ',
                         $this->set['attribute']);
-            } else {
+            } else {

                 $SQL = "UPDATE {$this->makeTable('web_user_attributes')} SET " . implode(', ',
                         $this->set['attribute']) . " WHERE  internalKey = " . $this->getID();
             }
             $this->query($SQL);
         }
         unset($fld['id']);
-        foreach ($fld as $key => $value) {
-            if ($value == '' || !$this->isChanged($key)) {
+        foreach ($fld as $key => $value) {

+            if ($value == '' || !$this->isChanged($key)) {

                 continue;
             }
             $result = $this->query("SELECT `setting_value` FROM {$this->makeTable('web_user_settings')} WHERE `webuser` = '{$this->id}' AND `setting_name` = '{$key}'");
-            if ($this->modx->db->getRecordCount($result) > 0) {
+            if ($this->modx->db->getRecordCount($result) > 0) {

                 $this->query("UPDATE {$this->makeTable('web_user_settings')} SET `setting_value` = '{$value}' WHERE `webuser` = '{$this->id}' AND `setting_name` = '{$key}';");
-            } else {
+            } else {

                 $this->query("INSERT into {$this->makeTable('web_user_settings')} SET `webuser` = {$this->id},`setting_name` = '{$key}',`setting_value` = '{$value}';");
             }
         }
-        if (!$this->newDoc && $this->givenPassword) {
+        if (!$this->newDoc && $this->givenPassword) {

             $this->invokeEvent('OnWebChangePassword', array(
                 'userObj'      => $this,
                 'userid'       => $this->id,
@@ -240,7 +240,9 @@ 
             ), $fire_events);
         }
         
-        if ($this->groupIds) $this->setUserGroups($this->id, $this->groupIds);
+        if ($this->groupIds) {

+            $this->setUserGroups($this->id, $this->groupIds);

+        }

         
         $this->invokeEvent('OnWebSaveUser', array(
             'userObj' => $this,
@@ -249,7 +251,7 @@ 
             'user'    => $this->toArray()
         ), $fire_events);
 
-        if ($clearCache) {
+        if ($clearCache) {

             $this->clearCache($fire_events);
         }
 
@@ -261,9 +263,9 @@ 
      * @param bool $fire_events
      * @return bool|null|void
      */
-    public function delete($ids, $fire_events = false)
-    {
-        if ($this->edit($ids)) {
+    public function delete($ids, $fire_events = false)

+    {

+        if ($this->edit($ids)) {

             $flag = $this->query("
           DELETE user,attribute FROM {$this->makeTable('web_user_attributes')} as attribute
             LEFT JOIN {$this->makeTable('web_users')} as user ON user.id=attribute.internalKey
@@ -277,7 +279,7 @@ 
                 'username'    => $this->get('username'),
                 'timestamp'   => time()
             ), $fire_events);
-        } else {
+        } else {

             $flag = false;
         }
         $this->close();
@@ -292,13 +294,13 @@ 
      * @param bool $fire_events
      * @return bool
      */
-    public function authUser($id = 0, $fulltime = true, $cookieName = 'WebLoginPE', $fire_events = false)
-    {
+    public function authUser($id = 0, $fulltime = true, $cookieName = 'WebLoginPE', $fire_events = false)

+    {

         $flag = false;
-        if (null === $this->getID() && $id) {
+        if (null === $this->getID() && $id) {

             $this->edit($id);
         }
-        if (null !== $this->getID()) {
+        if (null !== $this->getID()) {

             $flag = true;
             $this->save(false);
             $this->SessionHandler('start', $cookieName, $fulltime);
@@ -318,10 +320,10 @@ 
      * @param int $id
      * @return bool
      */
-    public function checkBlock($id = 0)
-    {
+    public function checkBlock($id = 0)

+    {

         $tmp = clone $this;
-        if ($id && $tmp->getID() != $id) {
+        if ($id && $tmp->getID() != $id) {

             $tmp->edit($id);
         }
         $now = time();
@@ -342,17 +344,17 @@ 
      * @param bool $fire_events
      * @return bool
      */
-    public function testAuth($id, $password, $blocker, $fire_events = false)
-    {
+    public function testAuth($id, $password, $blocker, $fire_events = false)

+    {

         $tmp = clone $this;
-        if ($id && $tmp->getID() != $id) {
+        if ($id && $tmp->getID() != $id) {

             $tmp->edit($id);
         }
 
         $flag = $pluginFlag = false;
         if (
             (null !== $tmp->getID()) && (!$blocker || ($blocker && !$tmp->checkBlock($id)))
-        ) {
+        ) {

             $eventResult = $this->getInvokeEventResult('OnWebAuthentication', array(
                 'userObj'       => $this,
                 'userid'        => $tmp->getID(),
@@ -360,14 +362,14 @@ 
                 'userpassword'  => $password,
                 'savedpassword' => $tmp->get('password')
             ), $fire_events);
-            if (is_array($eventResult)) {
-                foreach ($eventResult as $result) {
+            if (is_array($eventResult)) {

+                foreach ($eventResult as $result) {

                     $pluginFlag = (bool)$result;
                 }
-            } else {
+            } else {

                 $pluginFlag = (bool)$eventResult;
             }
-            if (!$pluginFlag) {
+            if (!$pluginFlag) {

                 $flag = ($tmp->get('password') == $tmp->getPassword($password));
             }
         }
@@ -381,12 +383,12 @@ 
      * @param string $cookieName
      * @return bool
      */
-    public function AutoLogin($fulltime = true, $cookieName = 'WebLoginPE', $fire_events = null)
-    {
+    public function AutoLogin($fulltime = true, $cookieName = 'WebLoginPE', $fire_events = null)

+    {

         $flag = false;
-        if (isset($_COOKIE[$cookieName])) {
+        if (isset($_COOKIE[$cookieName])) {

             $cookie = explode('|', $_COOKIE[$cookieName], 3);
-            if (isset($cookie[0], $cookie[1], $cookie[2]) && strlen($cookie[0]) == 32 && strlen($cookie[1]) == 32) {
+            if (isset($cookie[0], $cookie[1], $cookie[2]) && strlen($cookie[0]) == 32 && strlen($cookie[1]) == 32) {

                 $this->close();
                 $q = $this->modx->db->query("SELECT id FROM " . $this->makeTable('web_users') . " WHERE md5(username)='{$this->escape($cookie[0])}'");
                 $id = $this->modx->db->getValue($q);
@@ -396,7 +398,7 @@ 
                     && $this->get('password') == $cookie[1] 
                     && $this->get('sessionid') == $cookie[2] 
                     && !$this->checkBlock($this->getID())
-                ) {
+                ) {

                     $flag = $this->authUser($this->getID(), $fulltime, $cookieName, $fire_events);
 
                 }
@@ -410,9 +412,9 @@ 
      * @param string $cookieName
      * @param null $fire_events
      */
-    public function logOut($cookieName = 'WebLoginPE', $fire_events = null)
-    {
-        if (!$uid = $this->modx->getLoginUserID('web')) {
+    public function logOut($cookieName = 'WebLoginPE', $fire_events = null)

+    {

+        if (!$uid = $this->modx->getLoginUserID('web')) {

             return;
         }
         $params = array(
@@ -437,11 +439,11 @@ 
      *
      * remeber может быть числом в секундах
      */
-    protected function SessionHandler($directive, $cookieName, $remember = true)
-    {
-        switch ($directive) {
+    protected function SessionHandler($directive, $cookieName, $remember = true)

+    {

+        switch ($directive) {

             case 'start':
-                if ($this->getID()) {
+                if ($this->getID()) {

                     $_SESSION['webShortname'] = $this->get('username');
                     $_SESSION['webFullname'] = $this->get('fullname');
                     $_SESSION['webEmail'] = $this->get('email');
@@ -455,13 +457,13 @@ 
                     $_SESSION['webUsrConfigSet'] = array();
                     $_SESSION['webUserGroupNames'] = $this->getUserGroups();
                     $_SESSION['webDocgroups'] = $this->getDocumentGroups();
-                    if ($remember) {
+                    if ($remember) {

                         $this->setAutoLoginCookie($cookieName, $remember);
                     }
                 }
                 break;
             case 'destroy':
-                if (isset($_SESSION['mgrValidated'])) {
+                if (isset($_SESSION['mgrValidated'])) {

                     unset($_SESSION['webShortname']);
                     unset($_SESSION['webFullname']);
                     unset($_SESSION['webEmail']);
@@ -477,8 +479,8 @@ 
                     unset($_SESSION['webDocgroups']);
 
                     setcookie($cookieName, '', time() - 60, '/');
-                } else {
-                    if (isset($_COOKIE[session_name()])) {
+                } else {

+                    if (isset($_COOKIE[session_name()])) {

                         setcookie(session_name(), '', time() - 60, '/');
                     }
                     setcookie($cookieName, '', time() - 60, '/');
@@ -493,8 +495,8 @@ 
     /**
      * @return bool
      */
-    public function isSecure()
-    {
+    public function isSecure()

+    {

         $out = $this->modxConfig('server_protocol') == 'http' ? false : true;
 
         return $out;
@@ -505,9 +507,9 @@ 
      * @param bool $remember
      * @return $this
      */
-    public function setAutoLoginCookie($cookieName, $remember = true)
-    {
-        if (!empty($cookieName) && $this->getID()) {
+    public function setAutoLoginCookie($cookieName, $remember = true)

+    {

+        if (!empty($cookieName) && $this->getID()) {

             $secure = $this->isSecure();
             $remember = is_bool($remember) ? (60 * 60 * 24 * 365 * 5) : (int)$remember;
             $cookieValue = array(md5($this->get('username')), $this->get('password'), $this->get('sessionid'), $remember);
@@ -523,11 +525,11 @@ 
      * @param int $userID
      * @return array
      */
-    public function getDocumentGroups($userID = 0)
-    {
+    public function getDocumentGroups($userID = 0)

+    {

         $out = array();
         $user = $this->switchObject($userID);
-        if (null !== $user->getID()) {
+        if (null !== $user->getID()) {

             $web_groups = $this->modx->getFullTableName('web_groups');
             $webgroup_access = $this->modx->getFullTableName('webgroup_access');
 
@@ -546,11 +548,11 @@ 
      * @param int $userID
      * @return array
      */
-    public function getUserGroups($userID = 0)
-    {
+    public function getUserGroups($userID = 0)

+    {

         $out = array();
         $user = $this->switchObject($userID);
-        if (null !== $user->getID()) {
+        if (null !== $user->getID()) {

             $web_groups = $this->makeTable('web_groups');
             $webgroup_names = $this->makeTable('webgroup_names');
 
@@ -569,15 +571,17 @@ 
      * @param array $groupIds
      * @return $this
      */
-    public function setUserGroups($userID = 0, $groupIds = array())
-    {
-        if (!is_array($groupIds)) return $this;
-        if ($this->newDoc && $userID == 0) {
+    public function setUserGroups($userID = 0, $groupIds = array())

+    {

+        if (!is_array($groupIds)) {

+            return $this;

+        }

+        if ($this->newDoc && $userID == 0) {

             $this->groupIds = $groupIds;
-        } else {
+        } else {

             $user = $this->switchObject($userID);
-            if ($uid = $user->getID()) {
-                foreach ($groupIds as $gid) {
+            if ($uid = $user->getID()) {

+                foreach ($groupIds as $gid) {

                     $this->query("REPLACE INTO {$this->makeTable('web_groups')} (`webgroup`, `webuser`) VALUES ('{$gid}', '{$uid}')");
                 }
             }