OSJ/lib/pkp/classes/submission/SubmissionComment.php

<?php

/**
 * @file classes/submission/SubmissionComment.php
 *
 * Copyright (c) 2014-2021 Simon Fraser University
 * Copyright (c) 2003-2021 John Willinsky
 * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
 *
 * @class SubmissionComment
 *
 * @ingroup submission
 *
 * @see SubmissionCommentDAO
 *
 * @brief Class for SubmissionComment.
 */

namespace PKP\submission;

use APP\facades\Repo;

class SubmissionComment extends \PKP\core\DataObject
{
    public const COMMENT_TYPE_PEER_REVIEW = 1;
    public const COMMENT_TYPE_EDITOR_DECISION = 2;
    public const COMMENT_TYPE_COPYEDIT = 3;
    public const COMMENT_TYPE_LAYOUT = 4;
    public const COMMENT_TYPE_PROOFREAD = 5;

    /**
     * get comment type
     *
     * @return int COMMENT_TYPE_...
     */
    public function getCommentType()
    {
        return $this->getData('commentType');
    }

    /**
     * set comment type
     *
     * @param int $commentType COMMENT_TYPE_...
     */
    public function setCommentType($commentType)
    {
        $this->setData('commentType', $commentType);
    }

    /**
     * get role id
     *
     * @return int
     */
    public function getRoleId()
    {
        return $this->getData('roleId');
    }

    /**
     * set role id
     *
     * @param int $roleId
     */
    public function setRoleId($roleId)
    {
        $this->setData('roleId', $roleId);
    }

    /**
     * get submission id
     *
     * @return int
     */
    public function getSubmissionId()
    {
        return $this->getData('submissionId');
    }

    /**
     * set submission id
     *
     * @param int $submissionId
     */
    public function setSubmissionId($submissionId)
    {
        $this->setData('submissionId', $submissionId);
    }

    /**
     * get assoc id
     *
     * @return int
     */
    public function getAssocId()
    {
        return $this->getData('assocId');
    }

    /**
     * set assoc id
     *
     * @param int $assocId
     */
    public function setAssocId($assocId)
    {
        $this->setData('assocId', $assocId);
    }

    /**
     * get author id
     *
     * @return int
     */
    public function getAuthorId()
    {
        return $this->getData('authorId');
    }

    /**
     * set author id
     *
     * @param int $authorId
     */
    public function setAuthorId($authorId)
    {
        $this->setData('authorId', $authorId);
    }

    /**
     * get author name
     *
     * @return string
     */
    public function getAuthorName()
    {
        // Reference used to set if not already fetched
        $authorFullName = & $this->getData('authorFullName');

        if (!isset($authorFullName)) {
            $user = Repo::user()->get($this->getAuthorId(), true);
            $authorFullName = $user->getFullName();
        }

        return $authorFullName ? $authorFullName : '';
    }

    /**
     * get author email
     *
     * @return string
     */
    public function getAuthorEmail()
    {
        // Reference used to set if not already fetched
        $authorEmail = & $this->getData('authorEmail');

        if (!isset($authorEmail)) {
            $user = Repo::user()->get($this->getAuthorId(), true);
            return $user->getEmail();
        }

        return $authorEmail ? $authorEmail : '';
    }

    /**
     * get comment title
     *
     * @return string
     */
    public function getCommentTitle()
    {
        return $this->getData('commentTitle');
    }

    /**
     * set comment title
     *
     * @param string $commentTitle
     */
    public function setCommentTitle($commentTitle)
    {
        $this->setData('commentTitle', $commentTitle);
    }

    /**
     * get comments
     *
     * @return string
     */
    public function getComments()
    {
        return $this->getData('comments');
    }

    /**
     * set comments
     *
     * @param string $comments
     */
    public function setComments($comments)
    {
        $this->setData('comments', $comments);
    }

    /**
     * get date posted
     *
     * @return string
     */
    public function getDatePosted()
    {
        return $this->getData('datePosted');
    }

    /**
     * set date posted
     *
     * @param string $datePosted
     */
    public function setDatePosted($datePosted)
    {
        $this->setData('datePosted', $datePosted);
    }

    /**
     * get date modified
     *
     * @return string
     */
    public function getDateModified()
    {
        return $this->getData('dateModified');
    }

    /**
     * set date modified
     *
     * @param string $dateModified
     */
    public function setDateModified($dateModified)
    {
        $this->setData('dateModified', $dateModified);
    }

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

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

if (!PKP_STRICT_MODE) {
    class_alias('\PKP\submission\SubmissionComment', '\SubmissionComment');
    foreach (['COMMENT_TYPE_PEER_REVIEW', 'COMMENT_TYPE_EDITOR_DECISION', 'COMMENT_TYPE_COPYEDIT', 'COMMENT_TYPE_LAYOUT', 'COMMENT_TYPE_PROOFREAD'] as $constantName) {
        define($constantName, constant('\SubmissionComment::' . $constantName));
    }
}