Docs For Class HarmoniFileModule

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.

copyright: 2004 Middlebury College
since: $Date: 2007/09/19 14:04:48 $
version: $Id: HarmoniFileModule.class.php,v 1.20 2007/09/19 14:04:48 adamfranco Exp $

Located in /polyphony/main/library/RepositoryInputOutputModules/modules/HarmoniFileModule.class.php (line 32)

RepositoryInputOutputModuleInterface
   |
   --HarmoniFileModule

Method Summary

obj HarmoniFileModule ()

void createWizardSteps (object $record, object $wizard)

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

string generateDisplay (mixed $repositoryId, mixed $assetId, object $record)

string generateDisplayForPartStructures (mixed $repositoryId, mixed $assetId, object $record, array $partStructures)

void updateFromWizard (object $record, object $wizard)

Methods

Constructor HarmoniFileModule (line 42)

Constructor

since: 10/19/04
access: public

obj HarmoniFileModule ()

createWizardSteps (line 77)

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.

Redefinition of:

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

createWizardStepsForPartStructures (line 59)

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.

Redefinition of:

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

generateDisplay (line 475)

Generate HTML for displaying the Record

since: 10/19/04
access: public

string generateDisplay (mixed $repositoryId, mixed $assetId, object $record)

object $record

Redefinition of:

RepositoryInputOutputModuleInterface::generateDisplay(): Generate HTML for displaying the Record

generateDisplayForPartStructures (line 499)

Generate HTML for displaying particular parts of the Record

since: 10/19/04
access: public

string generateDisplayForPartStructures (mixed $repositoryId, mixed $assetId, object $record, array $partStructures)

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

Redefinition of:

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

updateFromWizard (line 332)

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

Redefinition of:

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

Inherited Methods

Inherited From RepositoryInputOutputModuleInterface

RepositoryInputOutputModuleInterface::createWizardSteps()
RepositoryInputOutputModuleInterface::createWizardStepsForPartStructures()
RepositoryInputOutputModuleInterface::generateDisplay()
RepositoryInputOutputModuleInterface::generateDisplayForPartStructures()
RepositoryInputOutputModuleInterface::updateFromWizard()