{"id":141156,"date":"2018-09-03T07:14:22","date_gmt":"2018-09-03T07:14:22","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=141156"},"modified":"2019-01-08T08:02:18","modified_gmt":"2019-01-08T08:02:18","slug":"login-user-into-joomla-with-user-id","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/login-user-into-joomla-with-user-id\/","title":{"rendered":"Login a user into Joomla with the help of user id"},"content":{"rendered":"

Making a user logging into a framework deals with all security and concerns but there are times when an application requires login a user without repeatedly asking for credentials from that user. It could be a very specific but a needful requirement which many developers have come across in different platforms. Here we will discuss about a solution that how you could achieve a user login on to a Joomla platform. Joomla, as you might already know provide full support for add-on(s) in the form of plugins, modules, components and even additional libraries. Here we will discuss a simple piece of code which can be used in any section of your code, without even asking for any additional environment than the core structure of Joomla.<\/p>\n

Here I am writing a small function, which my extension will call at any point of time. Mostly it is in the very beginning when on particular request I get to know about which user is trying to interact with my application, and this code simply logins that user. Let say my function name is _forceLogin() which requires $userId as its only parameter. Also as in the beginning we require user id, so it must be available with the request. Retrieving $userId and calling _forceLogin() at particular instance will be like:<\/p>\n

\/**\r\n * Webkul Software.\r\n *\r\n * @category  Webkul\r\n * @author    Webkul\r\n * @copyright Copyright (c) 2010-2018 Webkul Software Private Limited (https:\/\/webkul.com)\r\n * @license   https:\/\/store.webkul.com\/license.html\r\n *\/\r\n$app = JFactory::getApplication();\r\n$jinput = $app->input;\r\n$userId = $jinput->post->get('userId', 0, 'INT');\r\n$userStatus = $this->_forceLogin($userId);\r\nif ($userStatus == 'guest') {\r\n    \/\/ user id not exist in sytem\r\n    echo JText::_(\"COM_WKAPI_ERROR_INAVID_USERID\");\r\n} elseif (!$userStatus) {\r\n    \/\/ unable to clear previous user session\r\n    echo JText::_(\"COM_WKAPI_ERROR_UNABLE_SESSION_CLEAR\");\r\n} elseif (is_array($userStatus) && $userStatus[0] == false) {\r\n     \/\/ user exist but account blocked\r\n     echo JText::_('JERROR_NOLOGIN_BLOCKED');\r\n}\r\n<\/pre>\n
Note:<\/strong>\u00a0‘JERROR_NOLOGIN_BLOCKED’ is a predefined Joomla message to represent the present user state.<\/p>\n
One of the important thing to be noticed here is the return response of _forceLogin() method as we have to follow and may come across certain conditions, which are:<\/p>\n
    \n
  1. We need to check if the provided user id is a valid user id in Joomla.<\/li>\n
  2. We need to check if a user is already logged in, and need to log out that first from the current session.<\/li>\n
  3. There could be a case that the user you want to login is not activated or enabled yet.<\/li>\n<\/ol>\n
    The function definition of _forceLogin() will be:<\/p>\n
    \/**\r\n * Webkul Software.\r\n *\r\n * @category  Webkul\r\n * @author    Webkul\r\n * @copyright Copyright (c) 2010-2018 Webkul Software Private Limited (https:\/\/webkul.com)\r\n * @license   https:\/\/store.webkul.com\/license.html\r\n *\r\n * @return mixed true on success\r\n *\/\r\nprivate function _forceLogin($userId)\r\n{\r\n    $app = JFactory::getApplication();\r\n    $logoutStatus = $app->logout();\r\n    if ($logoutStatus) {\r\n        $user = JFactory::getUser($userId);\r\n        if ($user->guest) {\r\n            return 'guest';\r\n        } else {\r\n            \/\/Will authorize you as this user.\r\n            JPluginHelper::importPlugin('user');\r\n            $options = array();\r\n            $options['action'] = 'core.login.site';\r\n            $response = new stdClass();\r\n            $response->username = $user->username;\r\n            $response->language = '';\r\n            $response->email = $user->email;\r\n            $response->password_clear = '';\r\n            $response->fullname = '';\r\n            $result = $app->triggerEvent('onUserLogin', array((array)$response, $options));\r\n            return $result;\r\n        }\r\n    } else {\r\n        return false;\r\n    }\r\n}\r\n<\/pre>\n
    \n
    \n
    \n
    Usage<\/h3>\n<\/div>\n<\/div>\n
    \n
    \n
    This requirement could be specific to an extension need. This approach is currently being used in building APIs, which when used in building Mobile apps, requires a user to be logged in automatically on app load. Such of these APIs are used in extensions which are available on the Webkul store here:<\/p>\n