root/trunk/examples/example_element_enum_optgroup.php

<?php
/**
 * Example for the Enum element using optgroups
 * 
 * $Id: example_element_enum.php 117 2004-08-26 13:08:37Z argh $
 *
 * @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',
                'display'        =>    'yes',
                'edit'            =>    'yes',
                'label'            =>    'Username',
                'title'            =>    'Username',
                'description'    =>    'Enter your username here. Maximum length: [ELEMENT_MAXLENGTH]',
                'default'        =>    'argh',
                'maxlength'        =>    '15',
                'minlength'        =>    '4',
            ),
        ),
        'country' => array(
            'type' => 'Enum',
            'attributes' => array(
                'required'        =>    'yes',
                'display'        =>    'yes',
                'edit'            =>    'yes',
                'label'            =>    'Country',
                'title'            =>    'Country',
                'description'    =>    'Choose the country you are from.',
                'values'        =>    array(
                    array(
                        'label'  =>  'Europe',
                        'values' =>  array(
                                        array(
                                            'label'    =>    'Germany',
                                            'value'    =>    'de',
                                        ),
                                        array(
                                            'label'    =>    'France',
                                            'value'    =>    'fr',
                                        )
                                )                     
                        ),
                    array(
                        'label'  =>  'America',
                        'values' =>  array(
                                        array(
                                            'label'    =>    'USA',
                                            'value'    =>    'us',
                                        ),
                                        array(
                                            'label'    =>    'Mexico',
                                            'value'    =>    'mx',
                                        ),                        
                        )
                    )
                ),
            ),
        ),
    );
    
    // 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
    $form->setAutoValidate( 'save' );

    // serialize the elements
    $elements    =    $form->renderForm();
    
    
    // ERROR DISPLAY ------------------------------------------------------
    // ask the form if it has been submitted and display errors. For
    // convenience and also to keep the examples easy to understand, all
    // the following examples will use teh helper methods of the examples
    // framework to display the errors and the form.
    if( $form->isSubmitted() )
    {
        displayErrors( $form ); // see patExampleGen/customFunctions.php
    }

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


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