Docs For Class PartAndValuesModule

Description

Search Modules generate forms for and collect/format the subitions of said forms for various Digital Repository search types.

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

Method Summary

object PartAndValuesModule (mixed $partStructFieldName, mixed $valueFieldName, string $fieldName)

string createSearchFields (object Repository $repository)

string createSearchForm (mixed $repository, string $action)

array getCurrentValues ()

mixed getSearchCriteria (object Repository $repository)

void init ()

void setCurrentValues (array $values)

Methods

Constructor PartAndValuesModule (line 33)

Constructor

object PartAndValuesModule (mixed $partStructFieldName, mixed $valueFieldName, string $fieldName)

createSearchFields (line 100)

Create the fields (without form tags) for searching

string createSearchFields (object Repository $repository)

createSearchForm (line 79)

Create a form for searching.

string createSearchForm (mixed $repository, string $action)

getCurrentValues (line 242)

Get an array of the current values to be added to a url. The keys of the arrays are the field-names in the appropriate context.

array getCurrentValues ()

getSearchCriteria (line 207)

Get the formatted search terms based on the submissions of the form

mixed getSearchCriteria (object Repository $repository)

init (line 46)

Initialize this object

void init ()

setCurrentValues (line 265)

Update the current values with data (maybe stored in the session for instance.

The keys of the arrays are the field-names in the appropriate context. This could have been originally fetched via getCurrentValues

void setCurrentValues (array $values)