root/trunk/examples/example_attributefilter_test.php

<?php
/**
 * Example 
 * 
 * $Id$
 *
 * @package     patForms
 * @subpackage  Examples
 * @author      gERD Schaufelberger <gerd@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',
                'default'        =>    '       String with spaces',
                'description'    =>    'Please enter your username here.',
            ),
        ),
    );

    // 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' );

    // create the test filter
    $filter =& patForms::createAttributeFilter( 'Test' );

    // get the element
    $el =& $form->getElementByName( 'username' );

    // apply the filter to the element
    $el->applyAttributeFilter( $filter );
    
    // Why not apply the filter for a second time - just to play with it...
    $el->applyAttributeFilter( $filter );

    $el->setAttribute( 'description', 'This is the new description, altered by the attribute filter!' );

    // 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();
?>