Open Journal Systems  3.3.0
ReviewFormElement.inc.php
1 <?php
2 
18 define('REVIEW_FORM_ELEMENT_TYPE_SMALL_TEXT_FIELD', 0x000001);
19 define('REVIEW_FORM_ELEMENT_TYPE_TEXT_FIELD', 0x000002);
20 define('REVIEW_FORM_ELEMENT_TYPE_TEXTAREA', 0x000003);
21 define('REVIEW_FORM_ELEMENT_TYPE_CHECKBOXES', 0x000004);
22 define('REVIEW_FORM_ELEMENT_TYPE_RADIO_BUTTONS', 0x000005);
23 define('REVIEW_FORM_ELEMENT_TYPE_DROP_DOWN_BOX', 0x000006);
24 
26 
31  function getLocalizedQuestion() {
32  return $this->getLocalizedData('question');
33  }
34 
40  return $this->getLocalizedData('description');
41  }
42 
48  return $this->getLocalizedData('possibleResponses');
49  }
50 
51  //
52  // Get/set methods
53  //
54 
59  function getReviewFormId() {
60  return $this->getData('reviewFormId');
61  }
62 
67  function setReviewFormId($reviewFormId) {
68  $this->setData('reviewFormId', $reviewFormId);
69  }
70 
75  function getSequence() {
76  return $this->getData('sequence');
77  }
78 
83  function setSequence($sequence) {
84  $this->setData('sequence', $sequence);
85  }
86 
91  function getElementType() {
92  return $this->getData('reviewFormElementType');
93  }
94 
99  function setElementType($reviewFormElementType) {
100  $this->setData('reviewFormElementType', $reviewFormElementType);
101  }
102 
107  function getRequired() {
108  return $this->getData('required');
109  }
110 
115  function setRequired($required) {
116  $this->setData('required', $required);
117  }
118 
123  function getIncluded() {
124  return $this->getData('included');
125  }
126 
131  function setIncluded($included) {
132  $this->setData('included', $included);
133  }
134 
140  function getQuestion($locale) {
141  return $this->getData('question', $locale);
142  }
143 
149  function setQuestion($question, $locale) {
150  $this->setData('question', $question, $locale);
151  }
152 
158  function getDescription($locale) {
159  return $this->getData('description', $locale);
160  }
161 
167  function setDescription($description, $locale) {
168  $this->setData('description', $description, $locale);
169  }
170 
176  function getPossibleResponses($locale) {
177  return $this->getData('possibleResponses', $locale);
178  }
179 
185  function setPossibleResponses($possibleResponses, $locale) {
186  $this->setData('possibleResponses', $possibleResponses, $locale);
187  }
188 
195  static $reviewFormElementTypeOptions = array(
196  '' => 'manager.reviewFormElements.chooseType',
197  REVIEW_FORM_ELEMENT_TYPE_SMALL_TEXT_FIELD => 'manager.reviewFormElements.smalltextfield',
198  REVIEW_FORM_ELEMENT_TYPE_TEXT_FIELD => 'manager.reviewFormElements.textfield',
199  REVIEW_FORM_ELEMENT_TYPE_TEXTAREA => 'manager.reviewFormElements.textarea',
200  REVIEW_FORM_ELEMENT_TYPE_CHECKBOXES => 'manager.reviewFormElements.checkboxes',
201  REVIEW_FORM_ELEMENT_TYPE_RADIO_BUTTONS => 'manager.reviewFormElements.radiobuttons',
202  REVIEW_FORM_ELEMENT_TYPE_DROP_DOWN_BOX => 'manager.reviewFormElements.dropdownbox'
203  );
204  return $reviewFormElementTypeOptions;
205  }
206 
212  static $multipleResponsesElementTypes = array(REVIEW_FORM_ELEMENT_TYPE_CHECKBOXES, REVIEW_FORM_ELEMENT_TYPE_RADIO_BUTTONS, REVIEW_FORM_ELEMENT_TYPE_DROP_DOWN_BOX);
213  return $multipleResponsesElementTypes;
214  }
215 }
216 
217 
DataObject\getData
& getData($key, $locale=null)
Definition: DataObject.inc.php:100
DataObject\getLocalizedData
getLocalizedData($key, $preferredLocale=null)
Definition: DataObject.inc.php:71
ReviewFormElement\setReviewFormId
setReviewFormId($reviewFormId)
Definition: ReviewFormElement.inc.php:67
ReviewFormElement\getRequired
getRequired()
Definition: ReviewFormElement.inc.php:107
DataObject
Any class with an associated DAO should extend this class.
Definition: DataObject.inc.php:18
ReviewFormElement\getQuestion
getQuestion($locale)
Definition: ReviewFormElement.inc.php:140
ReviewFormElement\getSequence
getSequence()
Definition: ReviewFormElement.inc.php:75
ReviewFormElement\getMultipleResponsesElementTypes
& getMultipleResponsesElementTypes()
Definition: ReviewFormElement.inc.php:211
ReviewFormElement\getReviewFormId
getReviewFormId()
Definition: ReviewFormElement.inc.php:59
ReviewFormElement\getLocalizedPossibleResponses
getLocalizedPossibleResponses()
Definition: ReviewFormElement.inc.php:47
ReviewFormElement\setIncluded
setIncluded($included)
Definition: ReviewFormElement.inc.php:131
ReviewFormElement\setDescription
setDescription($description, $locale)
Definition: ReviewFormElement.inc.php:167
ReviewFormElement
Basic class describing a review form element.
Definition: ReviewFormElement.inc.php:25
ReviewFormElement\getLocalizedDescription
getLocalizedDescription()
Definition: ReviewFormElement.inc.php:39
ReviewFormElement\getDescription
getDescription($locale)
Definition: ReviewFormElement.inc.php:158
ReviewFormElement\setRequired
setRequired($required)
Definition: ReviewFormElement.inc.php:115
ReviewFormElement\getReviewFormElementTypeOptions
& getReviewFormElementTypeOptions()
Definition: ReviewFormElement.inc.php:194
ReviewFormElement\getLocalizedQuestion
getLocalizedQuestion()
Definition: ReviewFormElement.inc.php:31
ReviewFormElement\getIncluded
getIncluded()
Definition: ReviewFormElement.inc.php:123
ReviewFormElement\setSequence
setSequence($sequence)
Definition: ReviewFormElement.inc.php:83
ReviewFormElement\setPossibleResponses
setPossibleResponses($possibleResponses, $locale)
Definition: ReviewFormElement.inc.php:185
DataObject\setData
setData($key, $value, $locale=null)
Definition: DataObject.inc.php:132
ReviewFormElement\getPossibleResponses
getPossibleResponses($locale)
Definition: ReviewFormElement.inc.php:176
ReviewFormElement\setElementType
setElementType($reviewFormElementType)
Definition: ReviewFormElement.inc.php:99
ReviewFormElement\setQuestion
setQuestion($question, $locale)
Definition: ReviewFormElement.inc.php:149
ReviewFormElement\getElementType
getElementType()
Definition: ReviewFormElement.inc.php:91