Source for file profile.php

Documentation is available at profile.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_admin
  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. require_once JPATH_ADMINISTRATOR . '/components/com_users/models/user.php';
  13.  
  14. /**
  15.  * User model.
  16.  *
  17.  * @package     Joomla.Administrator
  18.  * @subpackage  com_admin
  19.  * @since       1.6
  20.  */
  21. class AdminModelProfile extends UsersModelUser
  22. {
  23.     /**
  24.      * Method to get the record form.
  25.      *
  26.      * @param   array    $data      An optional array of data for the form to interogate.
  27.      * @param   boolean  $loadData  True if the form is to load its own data (default case), false if not.
  28.      *
  29.      * @return  JForm    A JForm object on success, false on failure
  30.      *
  31.      * @since   1.6
  32.      */
  33.     public function getForm($data = array(), $loadData = true)
  34.     {
  35.         // Get the form.
  36.         $form = $this->loadForm('com_admin.profile', 'profile', array('control' => 'jform', 'load_data' => $loadData));
  37.  
  38.         if (empty($form))
  39.         {
  40.             return false;
  41.         }
  42.  
  43.         // Check for username compliance and parameter set
  44.         $usernameCompliant = true;
  45.  
  46.         if ($this->loadFormData()->username)
  47.         {
  48.             $username = $this->loadFormData()->username;
  49.             $isUsernameCompliant  = !(preg_match('#[<>"\'%;()&\\s\\\\]|\\.\\./#', $username) || strlen(utf8_decode($username)) < 2);
  50.         }
  51.  
  52.         $this->setState('user.username.compliant', $isUsernameCompliant);
  53.  
  54.         if (!JComponentHelper::getParams('com_users')->get('change_login_name') && $isUsernameCompliant)
  55.         {
  56.             $form->setFieldAttribute('username', 'required', 'false');
  57.             $form->setFieldAttribute('username', 'readonly', 'true');
  58.             $form->setFieldAttribute('username', 'description', 'COM_ADMIN_USER_FIELD_NOCHANGE_USERNAME_DESC');
  59.         }
  60.  
  61.         return $form;
  62.     }
  63.  
  64.     /**
  65.      * Method to get the data that should be injected in the form.
  66.      *
  67.      * @return  mixed  The data for the form.
  68.      *
  69.      * @since   1.6
  70.      */
  71.     protected function loadFormData()
  72.     {
  73.         // Check the session for previously entered form data.
  74.         $data = JFactory::getApplication()->getUserState('com_users.edit.user.data', array());
  75.  
  76.         if (empty($data))
  77.         {
  78.             $data = $this->getItem();
  79.         }
  80.  
  81.         // Load the users plugins.
  82.         JPluginHelper::importPlugin('user');
  83.  
  84.         $this->preprocessData('com_admin.profile', $data);
  85.  
  86.         return $data;
  87.     }
  88.  
  89.     /**
  90.      * Method to get a single record.
  91.      *
  92.      * @param   integer  $pk  The id of the primary key.
  93.      *
  94.      * @return  mixed  Object on success, false on failure.
  95.      *
  96.      * @since   1.6
  97.      */
  98.     public function getItem($pk = null)
  99.     {
  100.         $user = JFactory::getUser();
  101.  
  102.         return parent::getItem($user->get('id'));
  103.     }
  104.  
  105.     /**
  106.      * Method to save the form data.
  107.      *
  108.      * @param   array  $data  The form data.
  109.      *
  110.      * @return  boolean  True on success.
  111.      *
  112.      * @since   1.6
  113.      */
  114.     public function save($data)
  115.     {
  116.         $user = JFactory::getUser();
  117.  
  118.         unset($data['id']);
  119.         unset($data['groups']);
  120.         unset($data['sendEmail']);
  121.         unset($data['block']);
  122.  
  123.         // Unset the username if it should not be overwritten
  124.         $username = $data['username'];
  125.         $isUsernameCompliant = $this->getState('user.username.compliant');
  126.  
  127.         if (!JComponentHelper::getParams('com_users')->get('change_login_name') && $isUsernameCompliant)
  128.         {
  129.             unset($data['username']);
  130.         }
  131.  
  132.         // Bind the data.
  133.         if (!$user->bind($data))
  134.         {
  135.             $this->setError($user->getError());
  136.  
  137.             return false;
  138.         }
  139.  
  140.         $user->groups = null;
  141.  
  142.         // Store the data.
  143.         if (!$user->save())
  144.         {
  145.             $this->setError($user->getError());
  146.  
  147.             return false;
  148.         }
  149.  
  150.         $this->setState('user.id', $user->id);
  151.  
  152.         return true;
  153.     }
  154. }

Documentation generated on Tue, 19 Nov 2013 15:11:18 +0100 by phpDocumentor 1.4.3