root/trunk/examples/example_datasrc_function.php

<?php
/**
 * Example for the Date element
 * 
 * $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(
        'area' => array(
            'type' => 'Enum',
            'attributes' => array(
                'required'        =>    'yes',
                'display'        =>    'yes',
                'edit'            =>    'yes',
                'label'            =>    'Area',
                'title'            =>    'Area',
                'style'            =>    'width:200px;',
                'description'    =>    'Choose the area to access here.',
                'values'        =>    array(),
            ),
        ),
    );
    
    // create the form
    $form    =&    patForms::createForm( $elementsDefinition, array( 'name' => 'myForm' ) );
    
    
    // DATASOURCE SETUP ------------------------------------------------------

   /**
    * The dummy function, used as a datasource for a patForms_Element_Enum
    * object
    *
    * @access    public
    * @param    string    $elementName    Name of the element
    * @return    array    $areas            Associative array, keys are values, values are labels
    */
    function getAreas( $element )
    {
        return    array(
            array(    
                'label' => 'No '.$element->getName(),
                'value'    =>    '1',
            ),
            array(    
                'label' => '----------',
                'value'    =>    '',
            ),
            array(    
                'label' => 'Foo',
                'value'    =>    '2',
            ),
            array(    
                'label' => 'Bar',
                'value'    =>    '3',
            ),
        );
    }

    // get the element
    $el =& $form->getElementByName( 'area' );
    
    // set the data source for the enum element. Make sure that you always give
    // the setDataSource() method a variable, as it is passed by reference and
    // just strings will not work.
    $datasourceFunction    =    "getAreas";

    // tell the element to use the datasource function
    $el->setDataSource( $datasourceFunction );


    // PROCESS FORM ------------------------------------------------------

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