OSJ/lib/pkp/classes/reviewForm/ReviewFormElement.php

<?php

/**
 * @file classes/reviewForm/ReviewFormElement.php
 *
 * Copyright (c) 2014-2021 Simon Fraser University
 * Copyright (c) 2000-2021 John Willinsky
 * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
 *
 * @class ReviewFormElement
 *
 * @ingroup reviewForm
 *
 * @see ReviewFormElementDAO
 *
 * @brief Basic class describing a review form element.
 *
 */

namespace PKP\reviewForm;

class ReviewFormElement extends \PKP\core\DataObject
{
    public const REVIEW_FORM_ELEMENT_TYPE_SMALL_TEXT_FIELD = 1;
    public const REVIEW_FORM_ELEMENT_TYPE_TEXT_FIELD = 2;
    public const REVIEW_FORM_ELEMENT_TYPE_TEXTAREA = 3;
    public const REVIEW_FORM_ELEMENT_TYPE_CHECKBOXES = 4;
    public const REVIEW_FORM_ELEMENT_TYPE_RADIO_BUTTONS = 5;
    public const REVIEW_FORM_ELEMENT_TYPE_DROP_DOWN_BOX = 6;

    /**
     * Get localized question.
     *
     * @return string
     */
    public function getLocalizedQuestion()
    {
        return $this->getLocalizedData('question');
    }

    /**
     * Get localized description.
     *
     * @return string
     */
    public function getLocalizedDescription()
    {
        return $this->getLocalizedData('description');
    }

    /**
     * Get localized list of possible responses.
     *
     * @return array
     */
    public function getLocalizedPossibleResponses()
    {
        return $this->getLocalizedData('possibleResponses');
    }

    //
    // Get/set methods
    //

    /**
     * Get the review form ID of the review form element.
     *
     * @return int
     */
    public function getReviewFormId()
    {
        return $this->getData('reviewFormId');
    }

    /**
     * Set the review form ID of the review form element.
     *
     * @param int $reviewFormId
     */
    public function setReviewFormId($reviewFormId)
    {
        $this->setData('reviewFormId', $reviewFormId);
    }

    /**
     * Get sequence of review form element.
     *
     * @return float
     */
    public function getSequence()
    {
        return $this->getData('sequence');
    }

    /**
     * Set sequence of review form element.
     *
     * @param float $sequence
     */
    public function setSequence($sequence)
    {
        $this->setData('sequence', $sequence);
    }

    /**
     * Get the type of the review form element.
     *
     * @return string
     */
    public function getElementType()
    {
        return $this->getData('reviewFormElementType');
    }

    /**
     * Set the type of the review form element.
     *
     * @param string $reviewFormElementType
     */
    public function setElementType($reviewFormElementType)
    {
        $this->setData('reviewFormElementType', $reviewFormElementType);
    }

    /**
     * Get required flag
     *
     * @return bool
     */
    public function getRequired()
    {
        return $this->getData('required');
    }

    /**
     * Set required flag
     */
    public function setRequired($required)
    {
        $this->setData('required', $required);
    }

    /**
     * get included
     *
     * @return bool
     */
    public function getIncluded()
    {
        return $this->getData('included');
    }

    /**
     * set included
     *
     * @param bool $included
     */
    public function setIncluded($included)
    {
        $this->setData('included', $included);
    }

    /**
     * Get question.
     *
     * @param string $locale
     *
     * @return string
     */
    public function getQuestion($locale)
    {
        return $this->getData('question', $locale);
    }

    /**
     * Set question.
     *
     * @param string $question
     * @param string $locale
     */
    public function setQuestion($question, $locale)
    {
        $this->setData('question', $question, $locale);
    }

    /**
     * Get description.
     *
     * @param string $locale
     *
     * @return string
     */
    public function getDescription($locale)
    {
        return $this->getData('description', $locale);
    }

    /**
     * Set description.
     *
     * @param string $description
     * @param string $locale
     */
    public function setDescription($description, $locale)
    {
        $this->setData('description', $description, $locale);
    }

    /**
     * Get possible response.
     *
     * @param string $locale
     *
     * @return string
     */
    public function getPossibleResponses($locale)
    {
        return $this->getData('possibleResponses', $locale);
    }

    /**
     * Set possibleResponse.
     *
     * @param string $locale
     */
    public function setPossibleResponses($possibleResponses, $locale)
    {
        $this->setData('possibleResponses', $possibleResponses, $locale);
    }

    /**
     * Get an associative array matching review form element type codes with locale strings.
     * (Includes default '' => "Choose One" string.)
     *
     * @return array reviewFormElementType => localeString
     */
    public function getReviewFormElementTypeOptions()
    {
        return [
            '' => 'manager.reviewFormElements.chooseType',
            self::REVIEW_FORM_ELEMENT_TYPE_SMALL_TEXT_FIELD => 'manager.reviewFormElements.smalltextfield',
            self::REVIEW_FORM_ELEMENT_TYPE_TEXT_FIELD => 'manager.reviewFormElements.textfield',
            self::REVIEW_FORM_ELEMENT_TYPE_TEXTAREA => 'manager.reviewFormElements.textarea',
            self::REVIEW_FORM_ELEMENT_TYPE_CHECKBOXES => 'manager.reviewFormElements.checkboxes',
            self::REVIEW_FORM_ELEMENT_TYPE_RADIO_BUTTONS => 'manager.reviewFormElements.radiobuttons',
            self::REVIEW_FORM_ELEMENT_TYPE_DROP_DOWN_BOX => 'manager.reviewFormElements.dropdownbox',
        ];
    }

    /**
     * Get an array of all multiple responses element types.
     *
     * @return array reviewFormElementTypes
     */
    public function getMultipleResponsesElementTypes()
    {
        return [
            self::REVIEW_FORM_ELEMENT_TYPE_CHECKBOXES,
            self::REVIEW_FORM_ELEMENT_TYPE_RADIO_BUTTONS,
            self::REVIEW_FORM_ELEMENT_TYPE_DROP_DOWN_BOX,
        ];
    }
}

if (!PKP_STRICT_MODE) {
    class_alias('\PKP\reviewForm\ReviewFormElement', '\ReviewFormElement');
    foreach ([
        'REVIEW_FORM_ELEMENT_TYPE_SMALL_TEXT_FIELD',
        'REVIEW_FORM_ELEMENT_TYPE_TEXT_FIELD',
        'REVIEW_FORM_ELEMENT_TYPE_TEXTAREA',
        'REVIEW_FORM_ELEMENT_TYPE_CHECKBOXES',
        'REVIEW_FORM_ELEMENT_TYPE_RADIO_BUTTONS',
        'REVIEW_FORM_ELEMENT_TYPE_DROP_DOWN_BOX',
    ] as $constantName) {
        define($constantName, constant('\ReviewFormElement::' . $constantName));
    }
}