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

Public Member Functions

 getActive ()
 
 getAssocId ()
 
 getAssocType ()
 
 getCompleteCount ()
 
 getDescription ($locale)
 
 getIncompleteCount ()
 
 getLocalizedDescription ()
 
 getLocalizedTitle ()
 
 getSequence ()
 
 getTitle ($locale)
 
 setActive ($active)
 
 setAssocId ($assocId)
 
 setAssocType ($assocType)
 
 setCompleteCount ($completeCount)
 
 setDescription ($description, $locale)
 
 setIncompleteCount ($incompleteCount)
 
 setSequence ($sequence)
 
 setTitle ($title, $locale)
 
- 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.

See also
ReviewerFormDAO

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

Member Function Documentation

◆ getActive()

ReviewForm::getActive ( )

Get active flag

Returns
int

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

References DataObject\getData().

◆ getAssocId()

ReviewForm::getAssocId ( )

Get the Id of the associated type.

Returns
int

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

References DataObject\getData().

◆ getAssocType()

ReviewForm::getAssocType ( )

Get the associated type.

Returns
int

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

References DataObject\getData().

◆ getCompleteCount()

ReviewForm::getCompleteCount ( )

Get the number of completed reviews for this review form.

Returns
int

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

References DataObject\getData().

◆ getDescription()

ReviewForm::getDescription (   $locale)

Get description.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

◆ getIncompleteCount()

ReviewForm::getIncompleteCount ( )

Get the number of incomplete reviews for this review form.

Returns
int

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

References DataObject\getData().

◆ getLocalizedDescription()

ReviewForm::getLocalizedDescription ( )

Get localized description.

Returns
string

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

References DataObject\getLocalizedData().

◆ getLocalizedTitle()

ReviewForm::getLocalizedTitle ( )

Get localized title.

Returns
string

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

References DataObject\getLocalizedData().

◆ getSequence()

ReviewForm::getSequence ( )

Get sequence of review form.

Returns
float

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

References DataObject\getData().

◆ getTitle()

ReviewForm::getTitle (   $locale)

Get title.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

◆ setActive()

ReviewForm::setActive (   $active)

Set active flag

Parameters
$activeint

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

References DataObject\setData().

◆ setAssocId()

ReviewForm::setAssocId (   $assocId)

Set the Id of the associated type.

Parameters
$assocIdint

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

References DataObject\setData().

◆ setAssocType()

ReviewForm::setAssocType (   $assocType)

Set the associated type.

Parameters
$assocTypeint

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

References DataObject\setData().

◆ setCompleteCount()

ReviewForm::setCompleteCount (   $completeCount)

Set the number of complete reviews for this review form.

Parameters
$completeCountint

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

References DataObject\setData().

◆ setDescription()

ReviewForm::setDescription (   $description,
  $locale 
)

Set description.

Parameters
$descriptionstring
$localestring

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

References DataObject\setData().

◆ setIncompleteCount()

ReviewForm::setIncompleteCount (   $incompleteCount)

Set the number of incomplete reviews for this review form.

Parameters
$incompleteCountint

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

References DataObject\setData().

◆ setSequence()

ReviewForm::setSequence (   $sequence)

Set sequence of review form.

Parameters
$sequencefloat

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

References DataObject\setData().

◆ setTitle()

ReviewForm::setTitle (   $title,
  $locale 
)

Set title.

Parameters
$titlestring
$localestring

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

References DataObject\setData().


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