Source for file controller.php

Documentation is available at controller.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_login
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8.  */
  9.  
  10. defined('_JEXEC') or die;
  11.  
  12. /**
  13.  * Login Controller
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_login
  17.  * @since       1.5
  18.  */
  19. class LoginController extends JControllerLegacy
  20. {
  21.     /**
  22.      * Typical view method for MVC based architecture
  23.      *
  24.      * This function is provide as a default implementation, in most cases
  25.      * you will need to override it in your own controllers.
  26.      *
  27.      * @param   boolean            If true, the view output will be cached
  28.      * @param   array  An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
  29.      * @return  JController        This object to support chaining.
  30.      * @since   1.5
  31.      */
  32.     public function display($cachable = false, $urlparams = false)
  33.     {
  34.         // Special treatment is required for this component, as this view may be called
  35.         // after a session timeout. We must reset the view and layout prior to display
  36.         // otherwise an error will occur.
  37.  
  38.         $this->input->set('view', 'login');
  39.         $this->input->set('layout', 'default');
  40.  
  41.         parent::display();
  42.     }
  43.  
  44.     /**
  45.      * Method to log in a user.
  46.      *
  47.      * @return  void 
  48.      */
  49.     public function login()
  50.     {
  51.         // Check for request forgeries.
  52.         JSession::checkToken('request') or jexit(JText::_('JINVALID_TOKEN'));
  53.  
  54.         $app = JFactory::getApplication();
  55.  
  56.         $model = $this->getModel('login');
  57.         $credentials = $model->getState('credentials');
  58.         $return = $model->getState('return');
  59.  
  60.         $result = $app->login($credentials, array('action' => 'core.login.admin'));
  61.  
  62.         if (!($result instanceof Exception))
  63.         {
  64.             $app->redirect($return);
  65.         }
  66.  
  67.         parent::display();
  68.     }
  69.  
  70.     /**
  71.      * Method to log out a user.
  72.      *
  73.      * @return  void 
  74.      */
  75.     public function logout()
  76.     {
  77.         JSession::checkToken('request') or jexit(JText::_('JInvalid_Token'));
  78.  
  79.         $app = JFactory::getApplication();
  80.  
  81.         $userid = $this->input->getInt('uid', null);
  82.  
  83.         $options = array(
  84.             'clientid' => ($userid) ? 0 : 1
  85.         );
  86.  
  87.         $result = $app->logout($userid, $options);
  88.  
  89.         if (!($result instanceof Exception))
  90.         {
  91.             $model     = $this->getModel('login');
  92.             $return = $model->getState('return');
  93.             $app->redirect($return);
  94.         }
  95.  
  96.         parent::display();
  97.     }
  98. }

Documentation generated on Tue, 19 Nov 2013 14:57:06 +0100 by phpDocumentor 1.4.3