HOME

<?php

/**
 * @file controllers/informationCenter/form/NewNoteForm.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 NewNoteForm
 *
 * @ingroup informationCenter_form
 *
 * @brief Form to display and post notes on a file
 */

namespace PKP\controllers\informationCenter\form;

use APP\core\Application;
use APP\template\TemplateManager;
use PKP\db\DAORegistry;
use PKP\form\Form;
use PKP\note\NoteDAO;

class NewNoteForm extends Form
{
    /**
     * Constructor.
     */
    public function __construct()
    {
        parent::__construct('controllers/informationCenter/notes.tpl');

        $this->addCheck(new \PKP\form\validation\FormValidatorPost($this));
        $this->addCheck(new \PKP\form\validation\FormValidatorCSRF($this));
    }

    /**
     * Return the assoc type for this note.
     *
     * @return int
     */
    public function getAssocType()
    {
        assert(false);
    }

    /**
     * Return the assoc ID for this note.
     *
     * @return int
     */
    public function getAssocId()
    {
        assert(false);
    }

    /**
     * Return the submit note button locale key.
     * Should be overriden by subclasses.
     *
     * @return string
     */
    public function getSubmitNoteLocaleKey()
    {
        assert(false);
    }

    /**
     * Get the new note form template. Subclasses can
     * override this method to define other template.
     *
     * @return string
     */
    public function getNewNoteFormTemplate()
    {
        return 'controllers/informationCenter/newNoteForm.tpl';
    }

    /**
     * @copydoc Form::fetch()
     *
     * @param null|mixed $template
     */
    public function fetch($request, $template = null, $display = false)
    {
        $templateMgr = TemplateManager::getManager($request);
        $noteDao = DAORegistry::getDAO('NoteDAO'); /** @var NoteDAO $noteDao */
        $templateMgr->assign([
            'notes' => $noteDao->getByAssoc($this->getAssocType(), $this->getAssocId()),
            'submitNoteText' => $this->getSubmitNoteLocaleKey(),
            'newNoteFormTemplate' => $this->getNewNoteFormTemplate(),
        ]);
        return parent::fetch($request, $template, $display);
    }

    /**
     * @copydoc Form::readInputData()
     */
    public function readInputData()
    {
        $this->readUserVars([
            'newNote'
        ]);
    }

    /**
     * @copydoc Form::execute()
     */
    public function execute(...$functionArgs)
    {
        $request = Application::get()->getRequest();
        $user = $request->getUser();

        $noteDao = DAORegistry::getDAO('NoteDAO'); /** @var NoteDAO $noteDao */
        $note = $noteDao->newDataObject();

        $note->setUserId($user->getId());
        $note->setContents($this->getData('newNote'));
        $note->setAssocType($this->getAssocType());
        $note->setAssocId($this->getAssocId());

        parent::execute(...$functionArgs);
        return $noteDao->insertObject($note);
    }
}