root/tags/RELEASE_0_9_0B1/examples/example_api_autovalidate.php

<?php
/**
 * Example showing the autovalidation feature.
 * 
 * $Id$
 *
 * @access        public
 * @package        patForms
 * @subpackage    Examples
 * @author        Sebastian Mordziol <argh@php-tools.net>
 * @license        LGPL, see license.txt for details
 * @link        http://www.php-tools.net
 */

    /**
     * Main examples prepend file, needed *only* for the examples framework!
     */
    include_once 'patExampleGen/prepend.php';
    $exampleGen->displayHead( 'Example' );

    
    // EXAMPLE START ------------------------------------------------------

    /**
     * main patForms class
     */
    require_once $neededFiles['patForms'];
    
    /**
     * patErrorManager class
     */
    require_once $neededFiles['patErrorManager'];

    
    // element definitions for this example
    $elementsDefinition = array(
        'username' => array(
            'type' => 'String',
            'attributes' => array(
                'required'        =>    'yes',
                'label'            =>    'Username',
                'description'    =>    'Enter your username here. Maximum length: [ELEMENT_MAXLENGTH]',
                'maxlength'        =>    '15',
                'minlength'        =>    '4',
                'title'            =>    'Username',
            ),
        ),
    );
    
    // create the form
    $form    =&    patForms::createForm( $elementsDefinition, array( 'name' => 'myForm' ) );
    
    // create the needed renderer
    $renderer    =&    patForms::createRenderer( "Array" );
    
    // set the renderer
    $form->setRenderer( $renderer );
    
    // use auto-validation - in this case, the form is validated 
    // automatically when renderForm() is called, and you can
    // check whether the form is valid by checking for validation
    // errors via the getValidationErrors() method.
    $form->setAutoValidate( 'save' );

    // serialize the elements
    $elements = $form->renderForm();
    
    
    // ERROR DISPLAY ------------------------------------------------------
    // ask the form if it has been submitted. Note that you
    // do not need the setSubmitted() and validateForm() function
    // calls with the autovalidation feature. You just need to 
    // make sure you call this after the renderForm() call, at which
    // point the form is automatically validated.
    if( $form->isSubmitted() )
    {
        displayErrors( $form ); // see patExampleGen/customFunctions.php
    }

    // DISPLAY FORM ------------------------------------------------------
    displayForm( $form, $elements ); // see patExampleGen/customFunctions.php


    
    
    // EXAMPLE END ------------------------------------------------------
    $exampleGen->displayFooter();
?>