root/tags/RELEASE_0_9_0B1/examples/patExampleGen/customFunctions.php

<?php
/**
 * Custom functions for the current examples collection - the functions
 * defined here are available for all examples.
 *
 * $Id$
 * 
 * @access        public
 * @package        patForms
 * @subpackage    Examples
 * @version        0.1
 * @author        Sebastian Mordziol <s.mordziol@metrix.de>
 * @link        http://www.php-tools.net
 */


   /**
    * Takes a patForms object, asks it if there are any validation
    * errors and displays them if need be. 
    *
    * NOTE: this is just a helper method for our examples collection,
    * so that you may concentrate on the relevant parts of the examples.
    * It does in no way represent the way it should be done :)
    *
    * @access    public
    * @param    object    &$form    The patForms object to use
    */
    function displayErrors( &$form )
    {
        // get the errors from the form object - if there are none,
        // this returns false so it is easy to check if there are any.
        $errors = $form->getValidationErrors();

        // if there are any errors, display them.
        if ($errors) {
            echo '<div class="piErrors">';
            echo '    <div class="piErrorsTitle">Validation failed</div>';
            echo '    <div class="piErrorsContent">';
            
            // the errors collection is an associative array with the
            // field names as keys, so we go through that.
            foreach ($errors as $elementName => $elementErrors) {
                $element =& $form->getElementByName( $elementName );
                
                if (is_array($element)) {
                    $element = $element[0];
                }
                
                if (!is_object($element)) {
                    patErrorManager::raiseError("patExampleGen::0001", "The getElementByName() method did not return an element.");
                }

                // each element can have more than one error - this
                // is rare, but can happen so this is an indexed array
                // with one error in each row.
                foreach ($elementErrors as $row => $error) {
                    echo '        <div class="piError">';
                    echo '             <b>'.$element->getAttribute( 'label' ).':</b> '.$error['message'].' ('.$error['element'].' element error #'.$error['code'].')<br/>';
                    echo '        </div>';
                }
            }

            echo '    </div>';
            echo '</div>';
        }
        // no errors, tell the world everything is fine
        else
        {
            
            echo '<div class="piHint">Validation successful.</div>';
        }
    }
    
    
   /**
    * Displays a standard form from the examples collection when the
    * form is rendered via the array renderer. Does not work for any
    * other examples.
    *
    * NOTE: this is just a helper method for our examples collection,
    * so that you may concentrate on the relevant parts of the examples.
    * It does in no way represent the way it should be done :)
    * 
    * @access    public
    * @param    object    &$form        The current form object
    * @param    array    $elements    The rendered elements from the 
    * @return    
    * @see        
    */
    function displayForm( &$form, $elements )
    {
        // output the opening form tag
        echo $form->serializeStart();
    
        // display all elements
        foreach( $elements as $element )
        {
            echo '<div style="margin-bottom:8px;">';
            echo $element['label']."<br>";
            echo "<div>".$element["element"]."</div>";
            
            if( isset( $element["description"] ) )
            {
                echo "<i>".$element["description"]."</i><br>";
            }
            
            echo '</div>';
        }
    
        // submit button, closing form tag
        echo '<input type="submit" name="save" value="Save form"/><br><br>';
        echo $form->serializeEnd();
        

        // form submitted? display all form values
        if( $form->isSubmitted() ) {
            $els =& $form->getElements();
            $cnt = count( $els );
            
            echo '<div class="piValues">';
            echo '    <div class="piValuesTitle">Submitted form values</div>';
            echo '    <div class="piValuesContent">';
            echo '        <table cellpadding="2" cellspacing="0" border="0">';

            for( $i = 0; $i < $cnt; $i++ ) {
                echo '<tr>';
                echo '    <td>'.$els[$i]->getAttribute( 'label' ).'</td><td>&nbsp;:&nbsp;</td><td>'.$els[$i]->getValue().'</td>';
                echo '</tr>';
            }

            echo '        </table>';
            echo '    </div>';
            echo '</div>';
        }
    }

?>