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

Public Member Functions

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

See Also
ReviewFormElementDAO

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

Member Function Documentation

ReviewFormElement::getElementType ( )

Get the type of the review form element.

Returns
string

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

References DataObject\getData().

ReviewFormElement::getIncluded ( )

get included

Returns
boolean

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

References DataObject\getData().

ReviewFormElement::getLocalizedPossibleResponses ( )

Get localized list of possible responses.

Returns
array

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

References DataObject\getLocalizedData().

Referenced by getReviewFormElementPossibleResponses().

ReviewFormElement::getLocalizedQuestion ( )

Get localized question.

Returns
string

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

References DataObject\getLocalizedData().

Referenced by getReviewFormElementQuestion().

& ReviewFormElement::getMultipleResponsesElementTypes ( )

Get an array of all multiple responses element types.

Returns
array reviewFormElementTypes

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

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

ReviewFormElement::getPossibleResponses (   $locale)

Get possible response.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

ReviewFormElement::getQuestion (   $locale)

Get question.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

ReviewFormElement::getRequired ( )

Get required flag

Returns
boolean

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

References DataObject\getData().

ReviewFormElement::getReviewFormElementId ( )

Get the ID of the review form element.

Returns
int

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

References DataObject\getId(), and Config\getVar().

ReviewFormElement::getReviewFormElementPossibleResponses ( )

Get localized list of possible responses.

Returns
array

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

References getLocalizedPossibleResponses(), and Config\getVar().

ReviewFormElement::getReviewFormElementQuestion ( )

DEPRECATED Get localized question.

Returns
string

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

References getLocalizedQuestion(), and Config\getVar().

& 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 174 of file ReviewFormElement.inc.php.

Referenced by ReviewFormElementForm\display(), and ReviewFormHandler\reviewFormElements().

ReviewFormElement::getReviewFormId ( )

Get the review form ID of the review form element.

Returns
int

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

References DataObject\getData().

ReviewFormElement::getSequence ( )

Get sequence of review form element.

Returns
float

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

References DataObject\getData().

ReviewFormElement::ReviewFormElement ( )

Constructor.

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

ReviewFormElement::setElementType (   $reviewFormElementType)

Set the type of the review form element.

Parameters
$reviewFormElementTypestring

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

References DataObject\setData().

ReviewFormElement::setIncluded (   $included)

set included

Parameters
$includedboolean

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

References DataObject\setData().

ReviewFormElement::setPossibleResponses (   $possibleResponses,
  $locale 
)

Set possibleResponse.

Parameters
$possibleResponsestring
$localestring

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

References DataObject\setData().

ReviewFormElement::setQuestion (   $question,
  $locale 
)

Set question.

Parameters
$questionstring
$localestring

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

References DataObject\setData().

ReviewFormElement::setRequired (   $required)

Set required flag

Parameters
$viewableboolean

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

References DataObject\setData().

ReviewFormElement::setReviewFormElementId (   $reviewFormElementId)

Set the ID of the review form element.

Parameters
$reviewFormElementIdint

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

References Config\getVar(), and DataObject\setId().

ReviewFormElement::setReviewFormId (   $reviewFormId)

Set the review form ID of the review form element.

Parameters
$reviewFormIdint

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

References DataObject\setData().

ReviewFormElement::setSequence (   $sequence)

Set sequence of review form element.

Parameters
$sequencefloat

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

References DataObject\setData().


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