joomla-platform / libraries / joomla / form / rules / email.php

<?php
/**
 * @package     Joomla.Platform
 * @subpackage  Form
 *
 * @copyright   Copyright (C) 2005 - 2011 Open Source Matters, Inc. All rights reserved.
 * @license     GNU General Public License version 2 or later; see LICENSE
 */

defined('JPATH_PLATFORM') or die;

jimport('joomla.form.formrule');

/**
 * Form Rule class for the Joomla Framework.
 *
 * @package     Joomla.Platform
 * @subpackage  Form
 * @since       11.1
 */
class JFormRuleEmail extends JFormRule
{
    /**
     * The regular expression to use in testing a form field value.
     *
     * @var     string
     * @since   11.1
     */
    protected $regex = '^[\w.-]+(\+[\w.-]+)*@\w+[\w.-]*?\.\w{2,4}$';

    /**
     * Method to test the email address and optionally check for uniqueness.
     *
     * @param   object  $element    The JXMLElement object representing the <field /> tag for the
     *                              form field object.
     * @param   mixed   $value      The form field value to validate.
     * @param   string  $group      The field name group control value. This acts as as an array
     *                              container for the field. For example if the field has name="foo"
     *                              and the group value is set to "bar" then the full field name
     *                              would end up being "bar[foo]".
     * @param   object  $input      An optional JRegistry object with the entire data set to validate
     *                              against the entire form.
     * @param   object  $form       The form object for which the field is being tested.
     *
     * @return  boolean True if the value is valid, false otherwise.
     * @since   11.1
     * @throws  JException on invalid rule.
     */
    public function test(& $element, $value, $group = null, & $input = null, & $form = null)
    {
        // If the field is empty and not required, the field is valid.
        $required = ((string) $element['required'] == 'true' || (string) $element['required'] == 'required');
        if (!$required && empty($value)) {
            return true;
        }

        // Test the value against the regular expression.
        if (!parent::test($element, $value, $group, $input, $form)) {
            return false;
        }

        // Check if we should test for uniqueness.
        $unique = ((string) $element['unique'] == 'true' || (string) $element['unique'] == 'unique');
        if ($unique) {

            // Get the database object and a new query object.
            $db     = JFactory::getDBO();
            $query  = $db->getQuery(true);

            // Build the query.
            $query->select('COUNT(*)');
            $query->from('#__users');
            $query->where('email = '.$db->quote($value));

            // Get the extra field check attribute.
            $userId = ($form instanceof JForm) ? $form->getValue('id') : '';
            $query->where($db->nameQuote('id').' <> '.(int) $userId);

            // Set and query the database.
            $db->setQuery($query);
            $duplicate = (bool) $db->loadResult();

            // Check for a database error.
            if ($db->getErrorNum()) {
                JError::raiseWarning(500, $db->getErrorMsg());
            }

            if ($duplicate) {
                return false;
            }
        }

        return true;
    }
}
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.