Docs For Class FieldSet

Description

the FieldSet holds a set of key=value pairs of data

version: $Id: FieldSet.class.php,v 1.7 2007/09/04 20:25:55 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/utilities/FieldSetValidator/FieldSet.class.php (line 15)

Direct descendents

Class	Description
ReferencedFieldSet	the ReferencedFieldSet holds a set of key=value pairs of data, where the value is passed by reference
FormFieldSet

Variable Summary

mixed $_fields

Method Summary

void FieldSet ([optional $fields = null])

void clear ()

int count ()

mixed get (string $key)

array getKeys ()

void set (string $key, mixed $val)

int unsetKey (string $key)

Variables

mixed $_fields (line 22)

an associative array of keys and values

var: the associative array
access: private

Methods

Constructor FieldSet (line 31)

the constructor

access: public

void FieldSet ([optional $fields = null])

optional $fields: array $fields an associative array of key/value pairs to initialize with

clear (line 86)

clears the fieldset

access: public

void clear ()

Redefined in descendants as:

FormFieldSet::clear()

count (line 64)

returns the number of fields set

return: the number of fields
access: public

int count ()

get (line 43)

returns the value of $key

return: the value associated with $key
access: public

mixed get (string $key)

string $key: the key to return

getKeys (line 53)

returns an array of keys

return: an array of keys that are set
access: public

array getKeys ()

set (line 76)

sets the value associated with $key to $val

access: public

void set (string $key, mixed $val)

string $key: the key
mixed $val: the value to set $key to

Redefined in descendants as:

ReferencedFieldSet::set() : sets the value associated with $key to $val
FormFieldSet::set()

unsetKey (line 97)

unsets the specified key

return: the number of fields
access: public

int unsetKey (string $key)

string $key: the key to unset