Source for file username.php

Documentation is available at username.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Platform
  4.  * @subpackage  Form
  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
  8.  */
  9.  
  10. defined('JPATH_PLATFORM') or die;
  11.  
  12. /**
  13.  * Form Rule class for the Joomla Platform.
  14.  *
  15.  * @package     Joomla.Platform
  16.  * @subpackage  Form
  17.  * @since       11.1
  18.  */
  19. class JFormRuleUsername extends JFormRule
  20. {
  21.     /**
  22.      * Method to test the username for uniqueness.
  23.      *
  24.      * @param   SimpleXMLElement  $element  The SimpleXMLElement object representing the <field /> tag for the form field object.
  25.      * @param   mixed             $value    The form field value to validate.
  26.      * @param   string            $group    The field name group control value. This acts as as an array container for the field.
  27.      *                                       For example if the field has name="foo" and the group value is set to "bar" then the
  28.      *                                       full field name would end up being "bar[foo]".
  29.      * @param   JRegistry         $input    An optional JRegistry object with the entire data set to validate against the entire form.
  30.      * @param   JForm             $form     The form object for which the field is being tested.
  31.      *
  32.      * @return  boolean  True if the value is valid, false otherwise.
  33.      *
  34.      * @since   11.1
  35.      */
  36.     public function test(SimpleXMLElement $element, $value, $group = null, JRegistry $input = null, JForm $form = null)
  37.     {
  38.         // Get the database object and a new query object.
  39.         $db = JFactory::getDbo();
  40.         $query = $db->getQuery(true);
  41.  
  42.         // Build the query.
  43.         $query->select('COUNT(*)')
  44.             ->from('#__users')
  45.             ->where('username = ' . $db->quote($value));
  46.  
  47.         // Get the extra field check attribute.
  48.         $userId = ($form instanceof JForm) ? $form->getValue('id') : '';
  49.         $query->where($db->quoteName('id') . ' <> ' . (int) $userId);
  50.  
  51.         // Set and query the database.
  52.         $db->setQuery($query);
  53.         $duplicate = (bool) $db->loadResult();
  54.  
  55.         if ($duplicate)
  56.         {
  57.             return false;
  58.         }
  59.  
  60.         return true;
  61.     }
  62. }

Documentation generated on Tue, 19 Nov 2013 15:16:35 +0100 by phpDocumentor 1.4.3