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

Public Member Functions

 getActive ()
 
 getAssocId ()
 
 getAssocType ()
 
 getDescription ($locale)
 
 getLocalizedDescription ()
 
 getLocalizedTitle ()
 
 getReviewFormId ()
 
 getReviewFormTitle ()
 
 getSequence ()
 
 getTitle ($locale)
 
 ReviewForm ()
 
 setActive ($active)
 
 setAssocId ($assocId)
 
 setAssocType ($assocType)
 
 setDescription ($description, $locale)
 
 setReviewFormId ($reviewFormId)
 
 setSequence ($sequence)
 
 setTitle ($title, $locale)
 
- 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.

See Also
ReviewerFormDAO

Definition at line 22 of file ReviewForm.inc.php.

Member Function Documentation

ReviewForm::getActive ( )

Get active flag

Returns
int

Definition at line 102 of file ReviewForm.inc.php.

References DataObject\getData().

ReviewForm::getAssocId ( )

Get the Id of the associated type.

Returns
int

Definition at line 70 of file ReviewForm.inc.php.

References DataObject\getData().

ReviewForm::getAssocType ( )

Get the associated type.

Returns
int

Definition at line 54 of file ReviewForm.inc.php.

References DataObject\getData().

ReviewForm::getDescription (   $locale)

Get description.

Parameters
$localestring
Returns
string

Definition at line 137 of file ReviewForm.inc.php.

References DataObject\getData().

ReviewForm::getLocalizedDescription ( )

Get localized description.

Returns
string

Definition at line 42 of file ReviewForm.inc.php.

References DataObject\getLocalizedData().

ReviewForm::getLocalizedTitle ( )

Get localized title.

Returns
string

Definition at line 34 of file ReviewForm.inc.php.

References DataObject\getLocalizedData().

Referenced by getReviewFormTitle().

ReviewForm::getReviewFormId ( )

Get the ID of the review form.

Returns
int

Definition at line 166 of file ReviewForm.inc.php.

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

ReviewForm::getReviewFormTitle ( )

DEPRECATED

Definition at line 152 of file ReviewForm.inc.php.

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

ReviewForm::getSequence ( )

Get sequence of review form.

Returns
float

Definition at line 86 of file ReviewForm.inc.php.

References DataObject\getData().

ReviewForm::getTitle (   $locale)

Get title.

Parameters
$localestring
Returns
string

Definition at line 119 of file ReviewForm.inc.php.

References DataObject\getData().

ReviewForm::ReviewForm ( )

Constructor.

Definition at line 26 of file ReviewForm.inc.php.

ReviewForm::setActive (   $active)

Set active flag

Parameters
$activeint

Definition at line 110 of file ReviewForm.inc.php.

References DataObject\setData().

ReviewForm::setAssocId (   $assocId)

Set the Id of the associated type.

Parameters
$assocIdint

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

References DataObject\setData().

ReviewForm::setAssocType (   $assocType)

Set the associated type.

Parameters
$assocTypeint

Definition at line 62 of file ReviewForm.inc.php.

References DataObject\setData().

ReviewForm::setDescription (   $description,
  $locale 
)

Set description.

Parameters
$descriptionstring
$localestring

Definition at line 146 of file ReviewForm.inc.php.

References DataObject\setData().

ReviewForm::setReviewFormId (   $reviewFormId)

Set the ID of the review form.

Parameters
$reviewFormIdint

Definition at line 175 of file ReviewForm.inc.php.

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

ReviewForm::setSequence (   $sequence)

Set sequence of review form.

Parameters
$sequencefloat

Definition at line 94 of file ReviewForm.inc.php.

References DataObject\setData().

ReviewForm::setTitle (   $title,
  $locale 
)

Set title.

Parameters
$titlestring
$localestring

Definition at line 128 of file ReviewForm.inc.php.

References DataObject\setData().


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