Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
ControlledVocab Class Reference
Inheritance diagram for ControlledVocab:
DataObject

Public Member Functions

 ControlledVocab ()
 
 enumerate ($settingName= 'name')
 
 getAssocId ()
 
 getAssocType ()
 
 getSymbolic ()
 
 setAssocId ($assocId)
 
 setAssocType ($assocType)
 
 setSymbolic ($symbolic)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
 getSupportedExtractionAdapters ()
 
 getSupportedInjectionAdapters ()
 
 getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata ($metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Basic class describing an controlled vocab.

See Also
ControlledVocabDAO

Definition at line 20 of file ControlledVocab.inc.php.

Member Function Documentation

ControlledVocab::ControlledVocab ( )

Constructor

Definition at line 24 of file ControlledVocab.inc.php.

ControlledVocab::enumerate (   $settingName = 'name')

Get a list of controlled vocabulary options.

Parameters
$settingNamestring optional
Returns
array $controlledVocabEntryId => name

Definition at line 85 of file ControlledVocab.inc.php.

References DAORegistry\getDAO(), and DataObject\getId().

ControlledVocab::getAssocId ( )

get assoc id

Returns
int

Definition at line 36 of file ControlledVocab.inc.php.

References DataObject\getData().

ControlledVocab::getAssocType ( )

Get associated type.

Returns
int

Definition at line 52 of file ControlledVocab.inc.php.

References DataObject\getData().

ControlledVocab::getSymbolic ( )

Get symbolic name.

Returns
string

Definition at line 68 of file ControlledVocab.inc.php.

References DataObject\getData().

ControlledVocab::setAssocId (   $assocId)

set assoc id

Parameters
$assocIdint

Definition at line 44 of file ControlledVocab.inc.php.

References DataObject\setData().

ControlledVocab::setAssocType (   $assocType)

Set associated type.

Parameters
$assocTypeint

Definition at line 60 of file ControlledVocab.inc.php.

References DataObject\setData().

ControlledVocab::setSymbolic (   $symbolic)

Set symbolic name.

Parameters
$symbolicstring

Definition at line 76 of file ControlledVocab.inc.php.

References DataObject\setData().


The documentation for this class was generated from the following file: