root/tags/RELEASE_0_9_0B1/examples/example_api_setvalues.php

<?php
/**
 * Example that shows the usage of patForms::setValues()
 * 
 * $Id$
 *
 * @access        public
 * @package        patForms
 * @subpackage    Examples
 * @author        Stephan Schmidt <schst@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 - note
    // that they are all grouped together in one
    // array, with the additional keys 'type' and
    // 'attributes'.
    $elementsDefinition = array(
        'username' => array(
            'type' => 'String',
            'attributes' => array(
                'required'        =>    'yes',
                'display'        =>    'yes',
                'edit'            =>    'yes',
                'label'            =>    'Username',
                'description'    =>    'Enter your username here. Maximum length: [ELEMENT_MAXLENGTH]',
                'default'        =>    'argh',
                'maxlength'        =>    '15',
                'minlength'        =>    '4',
                'title'            =>    'Username',
            ),
        ),
        'password' => array(
            'type' => 'String',
            'attributes' => array(
                'type'            =>    'password',
                'required'        =>    'yes',
                'display'        =>    'yes',
                'edit'            =>    'yes',
                'label'            =>    'Password',
                'description'    =>    'Enter your password here. Maximum length: [ELEMENT_MAXLENGTH]',
                'maxlength'        =>    '15',
                'minlength'        =>    '4',
                'title'            =>    'Password',
            ),
        ),
    );

    // create the form - and just set the elements definition
    // directly here to have patForms automatically create and
    // add all needed elements. The attributes of the form itself
    // can also be set here directly (the name, for instance)
    $form    =&    patForms::createForm( $elementsDefinition, array( 'name' => 'myForm' ) );
    
    // we are adding two radio elements that use the same name
    // so only one of them can be checked at once.
    $radioAtts1 = array(
                        'required'        =>    'yes',
                        'display'        =>    'yes',
                        'edit'            =>    'yes',
                        'label'            =>    'Area 51',
                        'title'            =>    'Area 51',
                        'description'    =>    'Click to select the area &quot;[ELEMENT_LABEL]&quot;.',
                        'clicklabel'    =>    'yes',
                        'value'            =>    '51',
                    );
    $radioAtts2 = array(
                        'required'        =>    'yes',
                        'display'        =>    'yes',
                        'edit'            =>    'yes',
                        'label'            =>    'Area 52',
                        'title'            =>    'Area 52',
                        'description'    =>    'Click to select the area &quot;[ELEMENT_LABEL]&quot;.',
                        'clicklabel'    =>    'yes',
                        'value'            =>    '52',
                    );
    
    // create the elements
    $radio1 = &$form->createElement('area', 'Radio', $radioAtts1);
    $radio2 = &$form->createElement('area', 'Radio', $radioAtts2);

    // add them to the form
    $form->addElement($radio1);
    $form->addElement($radio2);
    
    // create the needed renderer so patForms knows how to
    // display the elements. In this case the array renderer
    // is used, wich returns all serialized elements in an array.
    $renderer    =&    patForms::createRenderer( "Array" );
    
    // set the values for the elements
    // The keys of the array must match the names of the elements.
    // If a key does not have a corresponding element, it will be skipped.
    //
    // If you set the second parameter to true, it will override the user input
    // and allow you to build a form with static values
    $form->setValues(
                       array(
                               'username' => 'schst',
                               'password' => 'secret',
                               'area'     => 52,
                               'bogus'    => 'Not an element of the form'
                           ),
                       false
                   );
    
    // give patForms the array renderer
    $form->setRenderer( $renderer );
    
    // serialize the elements using the array renderer - in this
    // array are contained all serialized elements along with their
    // attribute collection for easy access. You decide where and
    // what to display.
    $elements = $form->renderForm();
    
    if( isset( $_POST['save'] ) )
    {
        $form->setSubmitted( true );
        
        $form->validateForm();
    }
    
    
    // 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();
?>