root/trunk/examples/patExampleGen/sections_filter.php

<?php
/**
 * Definitions for the examples on the patForms Filters
 *
 * $Id$
 *
 * @package        patForms
 * @subpackage    Examples
 * @author        Sebastian Mordziol <argh@php-tools.net>
 */

    $sections['Filter'] = array(
        'descr'        =>    'Filter allow you to modify the values that you get from the 
                        form automatically. A filter can be used in both directions: 
                        when passing data to an element and when fetching data from 
                        the element.<br>
                        Filters may be applied in two streams:
                        <ul>
                            <li>1. The HTTP stream which is between the browser and the patForms object (PATFORMS_FILTER_TYPE_HTTP)</li>
                            <li>2. The PHP stream which is between the patForms object and your PHP script (PATFORMS_FILTER_TYPE_PHP)</li>
                        </ul>',
        'basename'    =>    'example_filter_',
        'pages'        =>    array(
            'trim' => array(
                'title'    =>    'Trim',
                'descr'    =>    'This example shows how to use the \'Trim\' filter to 
                            remove leading and trailing whitespace from the value. It 
                            is applied in the HTTP stream, prior to validating the 
                            form element.'
            ),
            'multiplier' => array(
                'title'    =>    'Multiplier',
                'descr'    =>    'This example automatically transform hours that have been 
                            entered into the form into minutes and vice versa.
                            This filter is applied on the PHP stream, i.e. 
                            after the element has been validated.'
            ),
            'xss' => array(
                'title'    =>    'XSS (Cross-site-scripting attacks)',
                'descr'    =>    'This example demonstrates the use of the XSS filter to 
                            avoid cross site scripting attacks.',
                'tabs'  =>  array(
                    'hilights' => array(
                        'title' => 'Relevant parts',
                        'type'  => 'guide',
                        'file'  => '$exampleId.php',
                        'guide' => array(
                            array(
                                'lines' => '35-51',
                                'text' => 'The element definition with script tag as default value',
                            ),
                            array(
                                'lines' => '65-72',
                                'text' => 'Creating and adding the filter',
                            ),
                        ),
                    ),
                ),
            ),
            'function' => array(
                'title'    =>    'Function',
                'descr'    =>    'This shows how to apply a filter that uses any PHP funtion to filter the data.'
            ),
            'auto' => array(
                'title'    =>    'Automatic creation',
                'descr'    =>    'You can define filters for your elements and have them
                            be added to your form elements automatically via the 
                            patForms factory.',
                'tabs'  =>  array(
                    'hilights' => array(
                        'title' => 'Relevant parts',
                        'type'  => 'guide',
                        'file'  => '$exampleId.php',
                        'guide' => array(
                            array(
                                'lines' => '36-61',
                                'text' => 'The element definition with filters',
                            ),
                        ),
                    ),
                ),
            ),
        )
    );
?>