SubmittedFilterPlugin.php

<?php

/**
 * @file plugins/generic/submittedFilter/SubmittedFilterPlugin.php
 *
 * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
 *
 * @class SubmittedFilterPlugin
 *
 * @brief Adds a "Submitted" filter to the editorial submissions lists that shows
 *  only completed (fully submitted) submissions, excluding incomplete ones still
 *  in the submission wizard.
 */

namespace APP\plugins\generic\submittedFilter;

use APP\core\Application;
use Illuminate\Database\Query\Builder;
use PKP\plugins\GenericPlugin;
use PKP\plugins\Hook;

class SubmittedFilterPlugin extends GenericPlugin
{
    /** Query string parameter used by the new filter. */
    public const PARAM = 'isSubmitted';

    /**
     * @copydoc Plugin::register()
     *
     * @param null|mixed $mainContextId
     */
    public function register($category, $path, $mainContextId = null)
    {
        $success = parent::register($category, $path, $mainContextId);
        if ($success && $this->getEnabled($mainContextId)) {
            // Apply the filter to the submission query when the param is present.
            Hook::add('Submission::Collector', [$this, 'addQueryConstraint']);
            // Inject the filter control into the dashboard list panels.
            Hook::add('TemplateManager::display', [$this, 'addFilterToDashboard']);
        }
        return $success;
    }

    /**
     * @copydoc Plugin::getDisplayName()
     */
    public function getDisplayName()
    {
        return __('plugins.generic.submittedFilter.displayName');
    }

    /**
     * @copydoc Plugin::getDescription()
     */
    public function getDescription()
    {
        return __('plugins.generic.submittedFilter.description');
    }

    /**
     * Restrict the submissions query to completed submissions when the
     * isSubmitted filter is active.
     *
     * @param string $hookName
     * @param array $args [&$q (Builder), $collector (Collector)]
     */
    public function addQueryConstraint(string $hookName, array $args): bool
    {
        /** @var Builder $q */
        $q = $args[0];

        $request = Application::get()->getRequest();
        if (!$request || !$request->getUserVar(self::PARAM)) {
            return Hook::CONTINUE;
        }

        // Completed submission: wizard finished (submission_progress = '') and still
        // sitting in the Submission stage, i.e. not yet advanced to review,
        // copyediting or production.
        $q->where('s.submission_progress', '=', '')
            ->where('s.stage_id', '=', WORKFLOW_STAGE_ID_SUBMISSION);

        return Hook::CONTINUE;
    }

    /**
     * Add the "Submitted" filter alongside the existing "Incomplete" filter in
     * every submissions list panel on the editorial dashboard.
     *
     * @param string $hookName
     * @param array $args [$templateMgr, &$template, &$output]
     */
    public function addFilterToDashboard(string $hookName, array $args): bool
    {
        $templateMgr = $args[0];
        $template = $args[1];

        if ($template !== 'dashboard/index.tpl') {
            return Hook::CONTINUE;
        }

        $components = $templateMgr->getState('components');
        if (!is_array($components)) {
            return Hook::CONTINUE;
        }

        $submittedFilter = [
            'param' => self::PARAM,
            'value' => true,
            'title' => __('plugins.generic.submittedFilter.filter.submitted'),
        ];

        foreach ($components as &$component) {
            if (empty($component['filters']) || !is_array($component['filters'])) {
                continue;
            }
            foreach ($component['filters'] as &$group) {
                if (empty($group['filters']) || !is_array($group['filters'])) {
                    continue;
                }
                foreach ($group['filters'] as $filter) {
                    if (($filter['param'] ?? null) === 'isIncomplete') {
                        $group['filters'][] = $submittedFilter;
                        continue 3;
                    }
                }
            }
        }
        unset($component, $group);

        $templateMgr->setState(['components' => $components]);

        return Hook::CONTINUE;
    }
}