Skip to content

pkp/pkp-lib#12179 Use ContributorsListPanel.vue in QuickSubmit #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ajnyga wants to merge 1 commit into
base: main
Choose a base branch
from
Open

pkp/pkp-lib#12179 Use ContributorsListPanel.vue in QuickSubmit #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 44 additions & 6 deletions QuickSubmitForm.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,13 @@
use APP\submission\Submission;
use APP\template\TemplateManager;
use Exception;
use PKP\components\listPanels\ContributorsListPanel;
use PKP\config\Config;
use PKP\context\Context;
use PKP\core\Core;
use PKP\core\PKPRequest;
use PKP\core\PKPString;
use PKP\db\DAORegistry;
use PKP\facades\Locale;
use PKP\form\Form;
use PKP\form\validation\FormValidatorUrl;
Expand All @@ -38,6 +40,7 @@
use PKP\linkAction\LinkAction;
use PKP\linkAction\request\AjaxModal;
use PKP\security\Role;
use PKP\submission\GenreDAO;
use PKP\submission\PKPSubmission;
use PKP\submissionFile\SubmissionFile;
use PKP\userGroup\UserGroup;
Expand Down Expand Up @@ -246,9 +249,50 @@ public function display($request = null, $template = null)
'primaryLocale' => $this->_submission->getData('locale'),
]);

$this->setContributorsListPanelState($templateMgr);

parent::display($request, $template);
}

/**
* Set the state for the ContributorsListPanel.
*/
protected function setContributorsListPanelState(TemplateManager $templateMgr): void
{
$submission = $this->_submission;
$context = $this->_context;
$publication = $submission->getCurrentPublication();

$locales = collect($context->getSupportedSubmissionMetadataLocaleNames() + $submission->getPublicationLanguageNames())
->map(fn (string $name, string $locale) => ['key' => $locale, 'label' => $name])
->sortBy('key')
->values()
->toArray();

$authorItems = [];
foreach ($publication->getData('authors') as $contributor) {
$authorItems[] = Repo::author()->getSchemaMap($submission)->map($contributor);
}

$contributorsListPanel = new ContributorsListPanel(
'quickSubmitContributors',
__('publication.contributors'),
$submission,
$context,
$locales,
$authorItems,
true // canEditPublication — QuickSubmit is manager-only
);

$genreDao = DAORegistry::getDAO('GenreDAO'); /** @var GenreDAO $genreDao */
$contextGenres = $genreDao->getEnabledByContextId($context->getId())->toArray();

$templateMgr->setState([
'quickSubmitContributorsListPanel' => $contributorsListPanel->getConfig(),
'quickSubmitPublication' => Repo::publication()->getSchemaMap($submission, $contextGenres)->map($publication),
]);
}

/**
* @copydoc \PKP\form\Form::validate()
*/
Expand Down Expand Up @@ -508,12 +552,6 @@ public function execute(...$functionParams)

Repo::publication()->publish($publication);
}

// Index article.
$articleSearchIndex = Application::getSubmissionSearchIndex();
$articleSearchIndex->submissionMetadataChanged($this->_submission);
$articleSearchIndex->submissionFilesChanged($this->_submission);
$articleSearchIndex->submissionChangesFinished();
}

/**
Expand Down
2 changes: 1 addition & 1 deletion QuickSubmitPlugin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@
use APP\notification\NotificationManager;
use APP\template\TemplateManager;
use Exception;
use PKP\plugins\ImportExportPlugin;
use PKP\core\JSONMessage;
use PKP\notification\Notification;
use PKP\plugins\ImportExportPlugin;

class QuickSubmitPlugin extends ImportExportPlugin
{
Expand Down
36 changes: 16 additions & 20 deletions cypress/tests/functional/QuickSubmit.cy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,14 @@ describe('Quick Submit plugin tests', function() {
});

// Add an author
cy.get('a[id^="component-grid-users-author-authorgrid-addAuthor-button-"]').click();
cy.wait(1000); // Form init delay
cy.get('input[id^="givenName-en-"]').type('Quincy', {delay: 0});
cy.get('input[id^="familyName-en-"]').type('Submitter', {delay: 0});
cy.get('select[id="country"]').select('Canada');
cy.get('input[id^=email-]').type('qsubmitter@mailinator.com', {delay: 0});
cy.get('input[id^="affiliation-en-"]').type('Queens University', {delay: 0});
cy.get('label:contains("Author")').click();
cy.get('form[id="editAuthor"] button:contains("Save")').click();
cy.get('div:contains("Author added.")');
cy.get('button').contains('Add Contributor').click();
cy.get('.pkpFormField:contains("Given Name")').find('input[name*="-en"]').type('Quincy', {delay: 0});
cy.get('.pkpFormField:contains("Family Name")').find('input[name*="-en"]').type('Submitter', {delay: 0});
cy.get('.pkpFormField:contains("Country")').find('select').select('Canada');
cy.get('.pkpFormField:contains("Email")').find('input').type('qsubmitter@mailinator.com', {delay: 0});
cy.get(`input[name=contributorRoles][value="${Cypress.env('contributorRoleAuthor')}"]`).check();
cy.get('div[role=dialog]:contains("Add Contributor")').find('button').contains('Save').click();
cy.get('.listPanel__item:contains("Quincy Submitter")');

// Schedule for publication
cy.get('input#articlePublished').click();
Expand Down Expand Up @@ -87,16 +85,14 @@ describe('Quick Submit plugin tests', function() {
});

// Add an author
cy.get('a[id^="component-grid-users-author-authorgrid-addAuthor-button-"]').click();
cy.wait(1000); // Form init delay
cy.get('input[id^="givenName-en-"]').type('Quincy', {delay: 0});
cy.get('input[id^="familyName-en-"]').type('Submitter', {delay: 0});
cy.get('select[id="country"]').select('Canada');
cy.get('input[id^=email-]').type('qsubmitter@mailinator.com', {delay: 0});
cy.get('input[id^="affiliation-en-"]').type('Queens University', {delay: 0});
cy.get('label:contains("Author")').click();
cy.get('form[id="editAuthor"] button:contains("Save")').click();
cy.get('div:contains("Author added.")');
cy.get('button').contains('Add Contributor').click();
cy.get('.pkpFormField:contains("Given Name")').find('input[name*="-en"]').type('Quincy', {delay: 0});
cy.get('.pkpFormField:contains("Family Name")').find('input[name*="-en"]').type('Submitter', {delay: 0});
cy.get('.pkpFormField:contains("Country")').find('select').select('Canada');
cy.get('.pkpFormField:contains("Email")').find('input').type('qsubmitter@mailinator.com', {delay: 0});
cy.get(`input[name=contributorRoles][value="${Cypress.env('contributorRoleAuthor')}"]`).check();
cy.get('div[role=dialog]:contains("Add Contributor")').find('button').contains('Save').click();
cy.get('.listPanel__item:contains("Quincy Submitter")');

// Complete the submission
cy.get('form[id="quickSubmitForm"] button:contains("Save")').click();
Expand Down
11 changes: 9 additions & 2 deletions templates/index.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,15 @@

{fbvFormArea id="contributors"}
<!-- Contributors -->
{capture assign="authorGridUrl"}{url router=PKP\core\PKPApplication::ROUTE_COMPONENT component="grid.users.author.AuthorGridHandler" op="fetchGrid" submissionId=$submissionId publicationId=$publicationId escape=false}{/capture}
{load_url_in_div id="authorsGridContainer" url=$authorGridUrl}
<div id="quickSubmitContributorsListPanel">
<contributors-list-panel
v-bind="quickSubmitContributorsListPanel"
:items="quickSubmitPublication.authors"
:publication="quickSubmitPublication"
@updated:contributors="quickSubmitPublication.authors = $event"
@updated:publication="quickSubmitPublication = $event"
></contributors-list-panel>
</div>

{$additionalContributorsFields}
{/fbvFormArea}
Expand Down
Loading