Docs For Class DataContainerInterface

Description

The DataContainer Interface defines the required methods for any DataContainer class or child.

version: $Id: DataContainer.interface.php,v 1.6 2007/09/04 20:25:54 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Direct descendents

Class	Description
DataContainer	The DataContainer class encapsulates a FieldSet, and a RuleSet and sets up field-setting restrictions.

Method Summary

void add (string $field, ref $rule, [optional $error = null])

boolean checkAll ()

mixed get (string $field)

void init ()

boolean set (string $field, mixed $val)

Methods

add (line 32)

The add method adds a new field with associated rule and optional error if validation fails.

void add (string $field, ref $rule, [optional $error = null])

string $field: The key of the field to add.
ref $rule: object ValidatorRule $rule The validator rule to apply to the value set to this key.
optional $error: object Error $error The error to throw if validation of this key fails.

Redefined in descendants as:

DataContainer::add() : The add method adds a new field with associated rule and optional error if validation fails.

checkAll (line 62)

Goes through all the keys and makes sure they comply to the rules specified for them.

boolean checkAll ()

Redefined in descendants as:

DataContainer::checkAll() : Goes through all the keys and makes sure they comply to the rules specified for them.

get (line 42)

The get method returns the value stored in the FieldSet for $field.

mixed get (string $field)

Redefined in descendants as:

DataContainer::get() : The get method returns the value stored in the FieldSet for $field.

init (line 20)

The init function -- sets up the private variables.

void init ()

Redefined in descendants as:

set (line 53)

The set method sets the value for a field while checking constrictions.

boolean set (string $field, mixed $val)

Redefined in descendants as:

DataContainer::set() : The set method sets the value for a field while checking constrictions.
UserDataContainer::set() : The set method sets the value for a field while checking constrictions.