Source for file controller.php

Documentation is available at controller.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Site
  4.  * @subpackage  com_users
  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.  * Base controller class for Users.
  14.  *
  15.  * @package     Joomla.Site
  16.  * @subpackage  com_users
  17.  * @since       1.5
  18.  */
  19. class UsersController extends JControllerLegacy
  20. {
  21.     /**
  22.      * Method to display a view.
  23.      *
  24.      * @param   boolean            If true, the view output will be cached
  25.      * @param   array  An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
  26.      *
  27.      * @return  JController        This object to support chaining.
  28.      * @since   1.5
  29.      */
  30.     public function display($cachable = false, $urlparams = false)
  31.     {
  32.         // Get the document object.
  33.         $document    = JFactory::getDocument();
  34.  
  35.         // Set the default view name and format from the Request.
  36.         $vName   = $this->input->getCmd('view', 'login');
  37.         $vFormat = $document->getType();
  38.         $lName   = $this->input->getCmd('layout', 'default');
  39.  
  40.         if ($view = $this->getView($vName, $vFormat))
  41.         {
  42.             // Do any specific processing by view.
  43.             switch ($vName)
  44.             {
  45.                 case 'registration':
  46.                     // If the user is already logged in, redirect to the profile page.
  47.                     $user = JFactory::getUser();
  48.                     if ($user->get('guest') != 1)
  49.                     {
  50.                         // Redirect to profile page.
  51.                         $this->setRedirect(JRoute::_('index.php?option=com_users&view=profile', false));
  52.                         return;
  53.                     }
  54.  
  55.                     // Check if user registration is enabled
  56.                     if (JComponentHelper::getParams('com_users')->get('allowUserRegistration') == 0)
  57.                     {
  58.                         // Registration is disabled - Redirect to login page.
  59.                         $this->setRedirect(JRoute::_('index.php?option=com_users&view=login', false));
  60.                         return;
  61.                     }
  62.  
  63.                     // The user is a guest, load the registration model and show the registration page.
  64.                     $model = $this->getModel('Registration');
  65.                     break;
  66.  
  67.                 // Handle view specific models.
  68.                 case 'profile':
  69.  
  70.                     // If the user is a guest, redirect to the login page.
  71.                     $user = JFactory::getUser();
  72.                     if ($user->get('guest') == 1)
  73.                     {
  74.                         // Redirect to login page.
  75.                         $this->setRedirect(JRoute::_('index.php?option=com_users&view=login', false));
  76.                         return;
  77.                     }
  78.                     $model = $this->getModel($vName);
  79.                     break;
  80.  
  81.                 // Handle the default views.
  82.                 case 'login':
  83.                     $model = $this->getModel($vName);
  84.                     break;
  85.  
  86.                 case 'reset':
  87.                     // If the user is already logged in, redirect to the profile page.
  88.                     $user = JFactory::getUser();
  89.                     if ($user->get('guest') != 1)
  90.                     {
  91.                         // Redirect to profile page.
  92.                         $this->setRedirect(JRoute::_('index.php?option=com_users&view=profile', false));
  93.                         return;
  94.                     }
  95.  
  96.                     $model = $this->getModel($vName);
  97.                     break;
  98.  
  99.                 case 'remind':
  100.                     // If the user is already logged in, redirect to the profile page.
  101.                     $user = JFactory::getUser();
  102.                     if ($user->get('guest') != 1)
  103.                     {
  104.                         // Redirect to profile page.
  105.                         $this->setRedirect(JRoute::_('index.php?option=com_users&view=profile', false));
  106.                         return;
  107.                     }
  108.  
  109.                     $model = $this->getModel($vName);
  110.                     break;
  111.  
  112.                 default:
  113.                     $model = $this->getModel('Login');
  114.                     break;
  115.             }
  116.  
  117.             // Push the model into the view (as default).
  118.             $view->setModel($model, true);
  119.             $view->setLayout($lName);
  120.  
  121.             // Push document object into the view.
  122.             $view->document = $document;
  123.  
  124.             $view->display();
  125.         }
  126.     }
  127. }

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