<?php
/**
 * patForms attribute filter base class - extend this to create your own filters.
 *
 * $Id$
 *
 * @package		patForms
 * @subpackage	AttriibuteFilter
 */

/**
 * patForms filter base class - extend this to create your own filters.
 *
 * @package     patForms
 * @subpackage  attibuteFilter
 * @author      gERD Schaufelberger <gerd@php-toole.net>
 * @license     LGPL, see license.txt for details
 * @lik         http://www.php-tools.net
 */
class patForms_AttributeFilter
{
   /**
    * Filter attribute value on "apply"-event
    *
    * This method is applied when patForms_Element:applyAttributeFilter()
    * or patForms::applyAttributeFilter() is called.
    *
    * @abstract
    * @access   public
    * @param    string  element's type
    * @param    string  attribute's names
    * @param    mixed   attribute's value
    * @return   mixed   true on success, patError-object on error
    */
    function onApply($type, $attribute, &$value)
    {
        return true;
    }

   /**
    * Filter attribute value on "set"-event
    *
    * This method is invoced whenever patForms_Element::setAttribute() is called.
    * The exception is during the initializing process, when the form is created. 
    * When the element is new, there is no attribute filter available.
    *
    * @abstract
    * @access	public
    * @param	string	element's type
    * @param    string  attribute's names
    * @param    mixed   attribute's value
    * @return   mixed   true on success, patError-object on error
    */
    function onSet($type, $attribute, &$value)
    {
        return true;
    }
}
?>