CspBrowseBySupplementPlugin.php

<?php

namespace APP\plugins\generic\cspBrowseBySupplement;

use APP\core\Application;
use APP\facades\Repo;
use APP\issue\Collector as IssueCollector;
use PKP\config\Config;
use PKP\core\PKPApplication;
use PKP\navigationMenu\NavigationMenuItem;
use PKP\navigationMenu\NavigationMenuItemAssignment;
use PKP\plugins\GenericPlugin;
use PKP\plugins\Hook;

define('CSP_SUPPLEMENT_NMI_TYPE', 'CSP_SUPPLEMENT_NMI_');

class CspBrowseBySupplementPlugin extends GenericPlugin
{
    public function register($category, $path, $mainContextId = null)
    {
        $success = parent::register($category, $path);
        if (!Config::getVar('general', 'installed') || defined('RUNNING_UPGRADE')) {
            return $success;
        }
        if ($success && $this->getEnabled()) {
            Hook::add('NavigationMenus::itemTypes', [$this, 'addMenuItemTypes']);
            Hook::add('NavigationMenus::displaySettings', [$this, 'setMenuItemDisplayDetails']);
        }
        return $success;
    }

    public function getDisplayName()
    {
        return __('plugins.generic.cspBrowseBySupplement.name');
    }

    public function getDescription()
    {
        return __('plugins.generic.cspBrowseBySupplement.description');
    }

    public function addMenuItemTypes($hookName, $args)
    {
        $types = & $args[0];
        $types[CSP_SUPPLEMENT_NMI_TYPE] = [
            'title' => __('plugins.generic.cspBrowseBySupplement.navMenuItem'),
            'description' => __('plugins.generic.cspBrowseBySupplement.navMenuItem.description'),
        ];
    }

    public function setMenuItemDisplayDetails($hookName, $args)
    {
        $navigationMenuItem = & $args[0];
        $navigationMenu = & $args[1];

        if ($navigationMenuItem->getType() !== CSP_SUPPLEMENT_NMI_TYPE) {
            return false;
        }

        $request = Application::get()->getRequest();
        $context = $request->getContext();

        if (!$context) {
            return false;
        }

        $issues = Repo::issue()->getCollector()
            ->filterByContextIds([$context->getId()])
            ->filterByPublished(true)
            ->orderBy(IssueCollector::ORDERBY_DATE_PUBLISHED)
            ->getMany();

        $dispatcher = $request->getDispatcher();
        $children = [];

        foreach ($issues as $issue) {
            if (stripos($issue->getTitle('en') ?? '', 'Supplement') === false) {
                continue;
            }

            $volume = $issue->getVolume();
            $localizedTitle = $issue->getLocalizedTitle();
            $label = $volume ? "v.{$volume} {$localizedTitle}" : $localizedTitle;

            $childNmi = new NavigationMenuItem();
            $childNmi->setTitle($label, $context->getPrimaryLocale());
            $childNmi->setUrl($dispatcher->url(
                $request,
                PKPApplication::ROUTE_PAGE,
                null,
                'issue',
                'view',
                $issue->getBestIssueId()
            ));
            $childNmi->setIsDisplayed(true);

            $childAssignment = new NavigationMenuItemAssignment();
            $childAssignment->setMenuItem($childNmi);

            $children[] = $childAssignment;
        }

        if (!empty($children) && isset($navigationMenu->menuTree)) {
            foreach ($navigationMenu->menuTree as $assignment) {
                if ($assignment->getMenuItem()?->getType() === CSP_SUPPLEMENT_NMI_TYPE) {
                    $assignment->children = $children;
                    break;
                }
            }
        }

        $navigationMenuItem->setUrl('');
        $navigationMenuItem->setIsDisplayed(true);
        $navigationMenuItem->setIsChildVisible(!empty($children));

        return false;
    }
}