Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
ControlledVocabEntry Class Reference
Inheritance diagram for ControlledVocabEntry:
DataObject

Public Member Functions

 ControlledVocabEntry ()
 
 getControlledVocabId ()
 
 getLocalizedName ()
 
 getName ($locale)
 
 getSequence ()
 
 setControlledVocabId ($controlledVocabId)
 
 setName ($name, $locale)
 
 setSequence ($sequence)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
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()
 

Detailed Description

Basic class describing a controlled vocab.

See Also
ControlledVocabEntryDAO

Definition at line 18 of file ControlledVocabEntry.inc.php.

Member Function Documentation

ControlledVocabEntry::ControlledVocabEntry ( )

Constructor

Definition at line 22 of file ControlledVocabEntry.inc.php.

ControlledVocabEntry::getControlledVocabId ( )

Get the ID of the controlled vocab.

Returns
int

Definition at line 34 of file ControlledVocabEntry.inc.php.

References DataObject\getData().

ControlledVocabEntry::getLocalizedName ( )

Get the localized name.

Returns
string

Definition at line 66 of file ControlledVocabEntry.inc.php.

References DataObject\getLocalizedData().

ControlledVocabEntry::getName (   $locale)

Get the name of the controlled vocabulary entry.

Parameters
$localestring
Returns
string

Definition at line 75 of file ControlledVocabEntry.inc.php.

References DataObject\getData().

ControlledVocabEntry::getSequence ( )

Get sequence number.

Returns
float

Definition at line 50 of file ControlledVocabEntry.inc.php.

References DataObject\getData().

ControlledVocabEntry::setControlledVocabId (   $controlledVocabId)

Set the ID of the controlled vocab.

Parameters
$controlledVocabIdint

Definition at line 42 of file ControlledVocabEntry.inc.php.

References DataObject\setData().

ControlledVocabEntry::setName (   $name,
  $locale 
)

Set the name of the controlled vocabulary entry.

Parameters
$namestring
$localestring

Definition at line 84 of file ControlledVocabEntry.inc.php.

References DataObject\setData().

ControlledVocabEntry::setSequence (   $sequence)

Set sequence number.

Parameters
$sequencefloat

Definition at line 58 of file ControlledVocabEntry.inc.php.

References DataObject\setData().


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