Docs For Class RepositoryInputOutputModuleInterface

Description

InputOutput modules are classes which generate HTML for the display or editing

of Records. Which InputOutput module to use is determined by the Format of the RecordStructure corresponding to that Record. For example, a Structure using the "DataManagerPrimitive" Format would use the DataManagerPrimative InputOutput module for displaying generating forms for editing its data.

version: $Id: RepositoryInputOutputModule.interface.php,v 1.5 2007/09/19 14:04:48 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /polyphony/main/library/RepositoryInputOutputModules/RepositoryInputOutputModule.interface.php (line 26)

Direct descendents

Class	Description
DataManagerPrimativesModule	InputOutput modules are classes which generate HTML for the display or editing
HarmoniFileModule	InputOutput modules are classes which generate HTML for the display or editing

Method Summary

void createWizardSteps (object $record, object $wizard)

void createWizardStepsForPartStructures (object $record, object $wizard, array $partStructures)

string generateDisplay (mixed $asset, object $record)

string generateDisplayForPartStructures (mixed $asset, object $record, array $partStructures)

void updateFromWizard (object $record, object $wizard)

Methods

createWizardSteps (line 38)

Create wizard steps for editing the values of the specified Record and add them to the wizard.

since: 10/19/04
access: public

void createWizardSteps (object $record, object $wizard)

object $record
object $wizard: The wizard to add the steps to.

Redefined in descendants as:

DataManagerPrimativesModule::createWizardSteps() : Create wizard steps for editing the values of the specified Record and add them to the wizard.
HarmoniFileModule::createWizardSteps() : Create wizard steps for editing the values of the specified Record and add them to the wizard.

createWizardStepsForPartStructures (line 53)

Create wizard steps for editing the values of the specified Record and add them to the wizard.

since: 10/19/04
access: public

void createWizardStepsForPartStructures (object $record, object $wizard, array $partStructures)

object $record
object $wizard: The wizard to add the steps to.
array $partStructures: An ordered array of the partstructures to include.

Redefined in descendants as:

DataManagerPrimativesModule::createWizardStepsForPartStructures() : Create wizard steps for editing the values of the specified Record and add them to the wizard.
HarmoniFileModule::createWizardStepsForPartStructures() : Create wizard steps for editing the values of the specified Record and add them to the wizard.

generateDisplay (line 78)

Generate HTML for displaying the Record

since: 10/19/04
access: public

string generateDisplay (mixed $asset, object $record)

object $record

Redefined in descendants as:

DataManagerPrimativesModule::generateDisplay() : Generate HTML for displaying the Record
HarmoniFileModule::generateDisplay() : Generate HTML for displaying the Record

generateDisplayForPartStructures (line 91)

Generate HTML for displaying particular parts of the Record

since: 10/19/04
access: public

string generateDisplayForPartStructures (mixed $asset, object $record, array $partStructures)

object $record: The record to print.
array $partStructures: An array of particular partstructures to print.

Redefined in descendants as:

DataManagerPrimativesModule::generateDisplayForPartStructures() : Generate HTML for displaying particular parts of the Record
HarmoniFileModule::generateDisplayForPartStructures() : Generate HTML for displaying particular parts of the Record

updateFromWizard (line 66)

Get the values submitted in the wizard and update the Record with them.

since: 10/19/04
access: public

void updateFromWizard (object $record, object $wizard)

object $record
object $wizard

Redefined in descendants as:

DataManagerPrimativesModule::updateFromWizard() : Get the values submitted in the wizard and update the Record with them.
HarmoniFileModule::updateFromWizard() : Get the values submitted in the wizard and update the Record with them.