API16

API16:JModelForm/validate

From Joomla! Documentation

Revision as of 22:36, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Method to validate the form data. <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowiki>]</n...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

Method to validate the form data.

[Edit Descripton]

Template:Description:JModelForm/validate

Syntax

validate($form, $data)
Parameter Name Default Value Description
$form $form The form to validate against.
$data $data The data to validate.

Returns

mixed Array of filtered data if valid, false otherwise.

Defined in

libraries/joomla/application/component/modelform.php

Importing

jimport( 'joomla.application.component.modelform' );

Source Body

function validate($form, $data)
{
        // Filter and validate the form data.
        $data   = $form->filter($data);
        $return = $form->validate($data);

        // Check for an error.
        if (JError::isError($return)) {
                $this->setError($return->getMessage());
                return false;
        }

        // Check the validation results.
        if ($return === false)
        {
                // Get the validation messages from the form.
                foreach ($form->getErrors() as $message) {
                        $this->setError($message);
                }

                return false;
        }

        return $data;
}

[Edit See Also] Template:SeeAlso:JModelForm/validate

Examples

<CodeExamplesForm />