Source for file DataContainer.interface.php

<?php
 
/**
 * The DataContainer Interface defines the required methods for any DataContainer class or child.
 *
 * @package harmoni.utilities
 * 
 * @copyright Copyright &copy; 2005, Middlebury College
 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
 *
 * @version $Id: DataContainer.interface.php,v 1.6 2007/09/04 20:25:54 adamfranco Exp $
 */
class DataContainerInterface {
    
    /**
     * The init function -- sets up the private variables.
     * @access protected
     * @return void 
     ***/
    function init() {
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
    }
    
    /**
     * The add method adds a new field with associated rule and optional error if validation fails.
     * @param string $field The key of the field to add.
     * @param ref object ValidatorRule $rule The validator rule to apply to the value set to this key.
     * @param optional object Error $error The error to throw if validation of this key fails.
     * @access protected
     * @return void 
     ***/
    function add( $field, $rule, $error = null ) {
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
    }
    
    /**
     * The get method returns the value stored in the FieldSet for $field.
     * @param string $field The field to get.
     * @access public
     * @return mixed The value of $field.
     ***/
    function get( $field ) {
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
    }
    
    /**
     * The set method sets the value for a field while checking constrictions.
     * @param string $field The field to set.
     * @param mixed $val The value to set $field to.
     * @access public
     * @return boolean True if setting $field succeeds.
     ***/
    function set( $field, $val ) {
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
    }
    
    /**
     * Goes through all the keys and makes sure they comply to the rules specified for them.
     * @access public
     * @return boolean TRUE if all are OK, FALSE otherwise.
     ***/
    function checkAll() {
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    }
    
}
 
?>