Docs For Class ConfigSystem

Description

version: $Id: ConfigSystem.class.php,v 1.11 2007/09/19 14:04:43 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /polyphony/main/library/ConfigSystem/ConfigSystem.class.php (line 22)

Variable Summary

array $_defaults

object $_record

object $_schema

object $_schemaType

boolean $_setup

Method Summary

ConfigSystem ConfigSystem (string $program)

void addProperty (ref $field, [optional $default = null])

void finishSetup ()

ref getRecord ([optional $force = false])

void save ()

Variables

array $_defaults (line 51)

var: An array of Primitives describing the default values for each property.
access: private

object $_record (line 40)

var: The Record which is associated with this config system.
access: private

object $_schema (line 28)

var: The Schema corresponding to our config setup.
access: private

object $_schemaType (line 46)

var: A HarmoniType object associated with our Record.
access: private

boolean $_setup (line 34)

var: Specifies if we are in setup mode, or "change settings" mode.
access: private

Methods

Constructor ConfigSystem (line 57)

The constructor.

ConfigSystem ConfigSystem (string $program)

string $program: The name of the program to setup configuration for, such as "Segue" or "Concerto".

addProperty (line 88)

Adds a property with the name & type specified. This is used while setting up the config system.

access: public

void addProperty (ref $field, [optional $default = null])

ref $field: object $field A SchemaField defining the properties of this field.
optional $default: object $default The default value for this property. Must be the correct class that is associated with the SchemaField type value, as defined by the DataTypeManager.

finishSetup (line 103)

Tells the ConfigSystem to finish setup and change into a mode where settings can actually be changed/added, etc.

access: public

void finishSetup ()

getRecord (line 138)

Returns a Record ready for editing permissions.

return: object
access: public

ref getRecord ([optional $force = false])

optional $force: boolean $force This option is only used internally.

save (line 126)

Saves all the config data to the database.

access: public

void save ()