Open Journal Systems  3.3.0
ControlledVocabEntry Class Reference
Inheritance diagram for ControlledVocabEntry:
DataObject InterestEntry SubmissionAgency SubmissionDiscipline SubmissionKeyword SubmissionLanguage SubmissionSubject

Public Member Functions

 getControlledVocabId ()
 
 getLocalizedName ()
 
 getName ($locale)
 
 getSequence ()
 
 setControlledVocabId ($controlledVocabId)
 
 setName ($name, $locale)
 
 setSequence ($sequence)
 
- Public Member Functions inherited from DataObject
 __construct ()
 
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
 getDAO ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
 getLocalizedData ($key, $preferredLocale=null)
 
 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)
 
 unsetData ($key, $locale=null)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

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

Detailed Description

Basic class describing a controlled vocab.

See also
ControlledVocabEntryDAO

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

Member Function Documentation

◆ getControlledVocabId()

ControlledVocabEntry::getControlledVocabId ( )

Get the ID of the controlled vocab.

Returns
int

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

References DataObject\getData().

◆ getLocalizedName()

ControlledVocabEntry::getLocalizedName ( )

Get the localized name.

Returns
string

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

References DataObject\getLocalizedData().

◆ getName()

ControlledVocabEntry::getName (   $locale)

Get the name of the controlled vocabulary entry.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

◆ getSequence()

ControlledVocabEntry::getSequence ( )

Get sequence number.

Returns
float

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

References DataObject\getData().

◆ setControlledVocabId()

ControlledVocabEntry::setControlledVocabId (   $controlledVocabId)

Set the ID of the controlled vocab.

Parameters
$controlledVocabIdint

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

References DataObject\setData().

◆ setName()

ControlledVocabEntry::setName (   $name,
  $locale 
)

Set the name of the controlled vocabulary entry.

Parameters
$namestring
$localestring

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

References DataObject\setData().

◆ setSequence()

ControlledVocabEntry::setSequence (   $sequence)

Set sequence number.

Parameters
$sequencefloat

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

References DataObject\setData().


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