pkp#9914 editorial history public page

bozana · May 3, 2024 · 704eb4b · 704eb4b
1 parent 4c027a9
commit 704eb4b
Show file tree

Hide file tree

Showing 7 changed files with 150 additions and 0 deletions.
diff --git a/classes/navigationMenu/NavigationMenuItem.php b/classes/navigationMenu/NavigationMenuItem.php
@@ -24,6 +24,7 @@ class NavigationMenuItem extends \PKP\core\DataObject
     public const NMI_TYPE_ABOUT = 'NMI_TYPE_ABOUT';
     public const NMI_TYPE_SUBMISSIONS = 'NMI_TYPE_SUBMISSIONS';
     public const NMI_TYPE_MASTHEAD = 'NMI_TYPE_MASTHEAD';
+    public const NMI_TYPE_EDITORIAL_HISTORY = 'NMI_TYPE_EDITORIAL_HISTORY';
     public const NMI_TYPE_EDITORIAL_TEAM = 'NMI_TYPE_EDITORIAL_TEAM';
     public const NMI_TYPE_CONTACT = 'NMI_TYPE_CONTACT';
     public const NMI_TYPE_ANNOUNCEMENTS = 'NMI_TYPE_ANNOUNCEMENTS';
@@ -313,6 +314,7 @@ class_alias('\PKP\navigationMenu\NavigationMenuItem', '\NavigationMenuItem');
         'NMI_TYPE_ABOUT',
         'NMI_TYPE_SUBMISSIONS',
         'NMI_TYPE_MASTHEAD',
+        'NMI_TYPE_EDITORIAL_HISTORY',
         'NMI_TYPE_EDITORIAL_TEAM',
         'NMI_TYPE_CONTACT',
         'NMI_TYPE_ANNOUNCEMENTS',

diff --git a/classes/services/PKPNavigationMenuService.php b/classes/services/PKPNavigationMenuService.php
@@ -62,6 +62,10 @@ public function getMenuItemTypes()
                 'title' => __('common.editorialMasthead'),
                 'description' => __('manager.navigationMenus.editorialMasthead.description'),
             ],
+            NavigationMenuItem::NMI_TYPE_EDITORIAL_HISTORY => [
+                'title' => __('common.editorialHistory'),
+                'description' => __('manager.navigationMenus.editorialHistory.description'),
+            ],
             NavigationMenuItem::NMI_TYPE_EDITORIAL_TEAM => [
                 'title' => __('about.editorialTeam'),
                 'description' => __('manager.navigationMenus.editorialTeam.description'),
@@ -266,6 +270,16 @@ public function getDisplayStatus(&$navigationMenuItem, &$navigationMenu)
                         null
                     ));
                     break;
+                case NavigationMenuItem::NMI_TYPE_EDITORIAL_HISTORY:
+                    $navigationMenuItem->setUrl($dispatcher->url(
+                        $request,
+                        PKPApplication::ROUTE_PAGE,
+                        null,
+                        'about',
+                        'editorialHistory',
+                        null
+                    ));
+                    break;
                 case NavigationMenuItem::NMI_TYPE_EDITORIAL_TEAM:
                     $navigationMenuItem->setUrl($dispatcher->url(
                         $request,

diff --git a/locale/en/common.po b/locale/en/common.po
@@ -157,6 +157,9 @@ msgstr "Peer Reviewers"
 msgid "common.editorialMasthead.peerReviewers.description"
 msgstr "The editors express their appreciation of the reviewers for {$year} listed below."
 
+msgid "common.editorialHistory"
+msgstr "Editorial History"
+
 msgid "common.name"
 msgstr "Name"
 

diff --git a/locale/en/manager.po b/locale/en/manager.po
@@ -2432,6 +2432,9 @@ msgstr ""
 msgid "manager.navigationMenus.editorialMasthead.description"
 msgstr "Link to a page displaying all active editorial masthead services."
 
+msgid "manager.navigationMenus.editorialHistory.description"
+msgstr "Link to a page displaying editorial history."
+
 msgid "manager.navigationMenus.submissions.description"
 msgstr "Link to the page displaying submission instructions."
 

diff --git a/pages/about/AboutContextHandler.php b/pages/about/AboutContextHandler.php
@@ -21,10 +21,12 @@
 use APP\handler\Handler;
 use APP\template\TemplateManager;
 use DateTime;
+use PKP\facades\Locale;
 use PKP\plugins\Hook;
 use PKP\security\authorization\ContextRequiredPolicy;
 use PKP\security\Role;
 use PKP\userGroup\relationships\enums\UserUserGroupMastheadStatus;
+use PKP\userGroup\relationships\enums\UserUserGroupStatus;
 use PKP\userGroup\relationships\UserUserGroup;
 
 class AboutContextHandler extends Handler
@@ -134,6 +136,86 @@ public function editorialMasthead($args, $request)
         $templateMgr->display('frontend/pages/editorialMasthead.tpl');
     }
 
+    /**
+     * Display editorial history page.
+     *
+     * @param array $args
+     * @param \PKP\core\PKPRequest $request
+     *
+     * @hook AboutContextHandler::editorialHistory [[$mastheadRoles, $mastheadUsers]]
+     */
+    public function editorialHistory($args, $request)
+    {
+        $context = $request->getContext();
+
+        $savedMastheadUserGroupIdsOrder = (array) $context->getData('mastheadUserGroupIds');
+
+        $collector = Repo::userGroup()->getCollector();
+        $allMastheadUserGroups = $collector
+            ->filterByContextIds([$context->getId()])
+            ->filterByMasthead(true)
+            ->orderBy($collector::ORDERBY_ROLE_ID)
+            ->getMany()
+            ->toArray();
+
+        // sort the masthead roles in their saved order for display
+        $mastheadRoles = array_replace(array_flip($savedMastheadUserGroupIdsOrder), $allMastheadUserGroups);
+
+        $mastheadUsers = [];
+        foreach ($mastheadRoles as $mastheadUserGroup) {
+            // Get all users that were active and are not active any more in the given role
+            // and that have accepted to be displayed on the masthead for that role.
+            // No need to filter by context ID, because the user groups are already filtered so.
+            $usersCollector = Repo::user()->getCollector();
+            $users = $usersCollector
+                ->filterByUserGroupIds([$mastheadUserGroup->getId()])
+                ->filterByUserUserGroupStatus(UserUserGroupStatus::STATUS_ENDED)
+                ->filterByUserUserGroupMastheadStatus(UserUserGroupMastheadStatus::STATUS_ON)
+                ->orderBy($usersCollector::ORDERBY_GIVENNAME, $usersCollector::ORDER_DIR_ASC, [Locale::getLocale(), Application::get()->getRequest()->getSite()->getPrimaryLocale()])
+                ->getMany();
+
+            foreach ($users as $user) {
+                $userUserGroups = UserUserGroup::withUserId($user->getId())
+                    ->withUserGroupId($mastheadUserGroup->getId())
+                    ->withEnded()
+                    ->withMasthead()
+                    ->get();
+                $services = [];
+                foreach ($userUserGroups as $userUserGroup) {
+                    $startDatetime = new DateTime($userUserGroup->dateStart);
+                    $endDatetime = new DateTime($userUserGroup->dateEnd);
+                    $services[] = [
+                        'dateStart' => $startDatetime->format('Y'),
+                        'dateEnd' => $endDatetime->format('Y'),
+                    ];
+                }
+                if (!empty($services)) {
+                    $mastheadUsers[$mastheadUserGroup->getId()][$user->getId()] = [
+                        'user' => $user,
+                        'services' => $services
+                    ];
+                }
+
+            }
+        }
+
+        Hook::call('AboutContextHandler::editorialHistory', [$mastheadRoles, $mastheadUsers]);
+
+        // To come after https://github.com/pkp/pkp-lib/issues/9771
+        // $orcidIcon = OrcidManager::getIcon();
+        $orcidIcon = '';
+
+        $templateMgr = TemplateManager::getManager($request);
+        $this->setupTemplate($request);
+        $templateMgr->assign([
+            'mastheadRoles' => $mastheadRoles,
+            'mastheadUsers' => $mastheadUsers,
+            'orcidIcon' => $orcidIcon
+        ]);
+        $templateMgr->display('frontend/pages/editorialHistory.tpl');
+    }
+
+
     /**
      * Display editorialTeam page.
      *

diff --git a/pages/about/index.php b/pages/about/index.php
@@ -20,6 +20,7 @@
 switch ($op) {
     case 'index':
     case 'editorialMasthead':
+    case 'editorialHistory':
     case 'editorialTeam':
     case 'submissions':
     case 'contact':

diff --git a/templates/frontend/pages/editorialHistory.tpl b/templates/frontend/pages/editorialHistory.tpl
@@ -0,0 +1,45 @@
+{**
+ * templates/frontend/pages/editorialHistory.tpl
+ *
+ * Copyright (c) 2024 Simon Fraser University
+ * Copyright (c) 2024 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @brief Display journal's editorial history page.
+ *
+ *}
+{include file="frontend/components/header.tpl" pageTitle="common.editorialHistory"}
+
+<div class="page page_masthead">
+	{include file="frontend/components/breadcrumbs.tpl" currentTitleKey="common.editorialHistory"}
+
+	<h1>{translate key="common.editorialHistory"}</h1>
+	{foreach from=$mastheadRoles item="mastheadRole"}
+		{if array_key_exists($mastheadRole->getId(), $mastheadUsers)}
+			<h2>{$mastheadRole->getLocalizedName()|escape}</h2>
+			<ul>
+			{foreach from=$mastheadUsers[$mastheadRole->getId()] item="mastheadUser"}
+				{foreach from=$mastheadUser['services'] item="service"}
+					<li>
+						{$mastheadUser['user']->getFullName()|escape},
+						{$mastheadUser['user']->getLocalizedData('affiliation')|escape},
+						{$service['dateStart']} - {$service['dateEnd']}
+						{if $mastheadUser['user']->getData('orcid')}
+							<span class="orcid">
+								{if $mastheadUser['user']->getData('orcidAccessToken')}
+									{$orcidIcon}
+								{/if}
+								<a href="{$mastheadUser['user']->getData('orcid')|escape}" target="_blank">
+								{$mastheadUser['user']->getData('orcid')|escape}
+							</a>
+							</span>
+						{/if}
+					</li>
+				{/foreach}
+			{/foreach}
+		</ul>
+		{/if}
+	{/foreach}
+</div><!-- .page -->
+
+{include file="frontend/components/footer.tpl"}