Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
CRAP
0.00% covered (danger)
0.00%
0 / 1
AbstractUserRequestAction
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
12
0.00% covered (danger)
0.00%
0 / 1
 handleRequest
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
12
1<?php
2
3/**
4 * Abstract base class for fetching information about user requests.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2019.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2,
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 *
23 * @category VuFind
24 * @package  AJAX
25 * @author   Demian Katz <demian.katz@villanova.edu>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org/wiki/development Wiki
28 */
29
30namespace VuFind\AjaxHandler;
31
32use Laminas\Mvc\Controller\Plugin\Params;
33
34/**
35 * Abstract base class for fetching information about user requests.
36 *
37 * @category VuFind
38 * @package  AJAX
39 * @author   Demian Katz <demian.katz@villanova.edu>
40 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
41 * @link     https://vufind.org/wiki/development Wiki
42 */
43abstract class AbstractUserRequestAction extends AbstractIlsAndUserAction
44{
45    use \VuFind\ILS\Logic\SummaryTrait;
46
47    /**
48     * ILS driver method for data retrieval.
49     *
50     * @var string
51     */
52    protected $lookupMethod;    // must be set in subclass
53
54    /**
55     * Handle a request.
56     *
57     * @param Params $params Parameter helper from controller
58     *
59     * @return array [response data, internal status code, HTTP status code]
60     */
61    public function handleRequest(Params $params)
62    {
63        $this->disableSessionWrites();  // avoid session write timing bug
64        $patron = $this->ilsAuthenticator->storedCatalogLogin();
65        if (!$patron) {
66            return $this->formatResponse('', self::STATUS_HTTP_NEED_AUTH);
67        }
68        if (!$this->ils->checkCapability($this->lookupMethod, [$patron])) {
69            return $this->formatResponse('', self::STATUS_HTTP_ERROR);
70        }
71        $requests = $this->ils->{$this->lookupMethod}($patron);
72        return $this->formatResponse($this->getRequestSummary($requests));
73    }
74}