Open Journal Systems  3.3.0
ReviewFormElement Class Reference
Inheritance diagram for ReviewFormElement:
DataObject

Public Member Functions

 getDescription ($locale)
 
 getElementType ()
 
 getIncluded ()
 
 getLocalizedDescription ()
 
 getLocalizedPossibleResponses ()
 
 getLocalizedQuestion ()
 
getMultipleResponsesElementTypes ()
 
 getPossibleResponses ($locale)
 
 getQuestion ($locale)
 
 getRequired ()
 
getReviewFormElementTypeOptions ()
 
 getReviewFormId ()
 
 getSequence ()
 
 setDescription ($description, $locale)
 
 setElementType ($reviewFormElementType)
 
 setIncluded ($included)
 
 setPossibleResponses ($possibleResponses, $locale)
 
 setQuestion ($question, $locale)
 
 setRequired ($required)
 
 setReviewFormId ($reviewFormId)
 
 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 review form element.

See also
ReviewFormElementDAO

Definition at line 25 of file ReviewFormElement.inc.php.

Member Function Documentation

◆ getDescription()

ReviewFormElement::getDescription (   $locale)

Get description.

Parameters
$localestring
Returns
string

Definition at line 158 of file ReviewFormElement.inc.php.

References DataObject\getData().

◆ getElementType()

ReviewFormElement::getElementType ( )

Get the type of the review form element.

Returns
string

Definition at line 91 of file ReviewFormElement.inc.php.

References DataObject\getData().

◆ getIncluded()

ReviewFormElement::getIncluded ( )

get included

Returns
boolean

Definition at line 123 of file ReviewFormElement.inc.php.

References DataObject\getData().

◆ getLocalizedDescription()

ReviewFormElement::getLocalizedDescription ( )

Get localized description.

Returns
string

Definition at line 39 of file ReviewFormElement.inc.php.

References DataObject\getLocalizedData().

◆ getLocalizedPossibleResponses()

ReviewFormElement::getLocalizedPossibleResponses ( )

Get localized list of possible responses.

Returns
array

Definition at line 47 of file ReviewFormElement.inc.php.

References DataObject\getLocalizedData().

◆ getLocalizedQuestion()

ReviewFormElement::getLocalizedQuestion ( )

Get localized question.

Returns
string

Definition at line 31 of file ReviewFormElement.inc.php.

References DataObject\getLocalizedData().

◆ getMultipleResponsesElementTypes()

& ReviewFormElement::getMultipleResponsesElementTypes ( )

Get an array of all multiple responses element types.

Returns
array reviewFormElementTypes

Definition at line 211 of file ReviewFormElement.inc.php.

Referenced by ReviewFormElementForm\execute(), and ReviewFormElementForm\fetch().

◆ getPossibleResponses()

ReviewFormElement::getPossibleResponses (   $locale)

Get possible response.

Parameters
$localestring
Returns
string

Definition at line 176 of file ReviewFormElement.inc.php.

References DataObject\getData().

◆ getQuestion()

ReviewFormElement::getQuestion (   $locale)

Get question.

Parameters
$localestring
Returns
string

Definition at line 140 of file ReviewFormElement.inc.php.

References DataObject\getData().

◆ getRequired()

ReviewFormElement::getRequired ( )

Get required flag

Returns
boolean

Definition at line 107 of file ReviewFormElement.inc.php.

References DataObject\getData().

◆ getReviewFormElementTypeOptions()

& ReviewFormElement::getReviewFormElementTypeOptions ( )

Get an associative array matching review form element type codes with locale strings. (Includes default '' => "Choose One" string.)

Returns
array reviewFormElementType => localeString

Definition at line 194 of file ReviewFormElement.inc.php.

Referenced by ReviewFormElementForm\fetch().

◆ getReviewFormId()

ReviewFormElement::getReviewFormId ( )

Get the review form ID of the review form element.

Returns
int

Definition at line 59 of file ReviewFormElement.inc.php.

References DataObject\getData().

◆ getSequence()

ReviewFormElement::getSequence ( )

Get sequence of review form element.

Returns
float

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

References DataObject\getData().

◆ setDescription()

ReviewFormElement::setDescription (   $description,
  $locale 
)

Set description.

Parameters
$descriptionstring
$localestring

Definition at line 167 of file ReviewFormElement.inc.php.

References DataObject\setData().

◆ setElementType()

ReviewFormElement::setElementType (   $reviewFormElementType)

Set the type of the review form element.

Parameters
$reviewFormElementTypestring

Definition at line 99 of file ReviewFormElement.inc.php.

References DataObject\setData().

◆ setIncluded()

ReviewFormElement::setIncluded (   $included)

set included

Parameters
$includedboolean

Definition at line 131 of file ReviewFormElement.inc.php.

References DataObject\setData().

◆ setPossibleResponses()

ReviewFormElement::setPossibleResponses (   $possibleResponses,
  $locale 
)

Set possibleResponse.

Parameters
$possibleResponsestring
$localestring

Definition at line 185 of file ReviewFormElement.inc.php.

References DataObject\setData().

◆ setQuestion()

ReviewFormElement::setQuestion (   $question,
  $locale 
)

Set question.

Parameters
$questionstring
$localestring

Definition at line 149 of file ReviewFormElement.inc.php.

References DataObject\setData().

◆ setRequired()

ReviewFormElement::setRequired (   $required)

Set required flag

Parameters
$viewableboolean

Definition at line 115 of file ReviewFormElement.inc.php.

References DataObject\setData().

◆ setReviewFormId()

ReviewFormElement::setReviewFormId (   $reviewFormId)

Set the review form ID of the review form element.

Parameters
$reviewFormIdint

Definition at line 67 of file ReviewFormElement.inc.php.

References DataObject\setData().

◆ setSequence()

ReviewFormElement::setSequence (   $sequence)

Set sequence of review form element.

Parameters
$sequencefloat

Definition at line 83 of file ReviewFormElement.inc.php.

References DataObject\setData().


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