lib/pkp/classes/controlledVocab/ControlledVocab.inc.php

   1 <?php
   2
   3 /**
   4  * @defgroup controlled_vocab
   5  */
   6
   7 /**
   8  * @file ControlledVocab.inc.php
   9  *
  10  * Copyright (c) 2000-2009 John Willinsky
  11  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  12  *
  13  * @class ControlledVocab
  14  * @ingroup controlled_vocab
  15  * @see ControlledVocabDAO
  16  *
  17  * @brief Basic class describing an controlled vocab.
  18  */
  19
  20 //$Id: ControlledVocab.inc.php,v 1.3 2009/05/13 00:13:20 asmecher Exp $
  21
  22 class ControlledVocab extends DataObject {
  23         //
  24         // Get/set methods
  25         //
  26
  27         /**
  28          * get assoc id
  29          * @return int
  30          */
  31         function getAssocId() {
  32                 return $this->getData('assocId');
  33         }
  34
  35         /**
  36          * set assoc id
  37          * @param $assocId int
  38          */
  39         function setAssocId($assocId) {
  40                 return $this->setData('assocId', $assocId);
  41         }
  42
  43         /**
  44          * Get associated type.
  45          * @return int
  46          */
  47         function getAssocType() {
  48                 return $this->getData('assocType');
  49         }
  50
  51         /**
  52          * Set associated type.
  53          * @param $assocType int
  54          */
  55         function setAssocType($assocType) {
  56                 return $this->setData('assocType', $assocType);
  57         }
  58
  59         /**
  60          * Get symbolic name.
  61          * @return string
  62          */
  63         function getSymbolic() {
  64                 return $this->getData('symbolic');
  65         }
  66
  67         /**
  68          * Set symbolic name.
  69          * @param $symbolic string
  70          */
  71         function setSymbolic($symbolic) {
  72                 return $this->setData('symbolic', $symbolic);
  73         }
  74
  75         /**
  76          * Get a list of controlled vocabulary options.
  77          * @param $settingName string optional
  78          * @return array $controlledVocabEntryId => name
  79          */
  80         function enumerate($settingName = 'name') {
  81                 $controlledVocabDao =& DAORegistry::getDAO('ControlledVocabDAO');
  82                 return $controlledVocabDao->enumerate($this->getId(), $settingName);
  83         }
  84 }
  85
  86 ?>