-
Notifications
You must be signed in to change notification settings - Fork 348
/
ILLRequestsTrait.php
188 lines (168 loc) · 6.6 KB
/
ILLRequestsTrait.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
<?php
/**
* ILL trait (for subclasses of AbstractRecord)
*
* PHP version 8
*
* Copyright (C) Villanova University 2010.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* @category VuFind
* @package Controller
* @author Demian Katz <demian.katz@villanova.edu>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link https://vufind.org Main Site
*/
namespace VuFind\Controller;
use function in_array;
use function is_array;
/**
* ILL trait (for subclasses of AbstractRecord)
*
* @category VuFind
* @package Controller
* @author Demian Katz <demian.katz@villanova.edu>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link https://vufind.org Main Site
*/
trait ILLRequestsTrait
{
/**
* Action for dealing with ILL requests.
*
* @return mixed
*/
public function illRequestAction()
{
$driver = $this->loadRecord();
// Stop now if the user does not have valid catalog credentials available:
if (!is_array($patron = $this->catalogLogin())) {
return $patron;
}
// If we're not supposed to be here, give up now!
$catalog = $this->getILS();
$checkRequests = $catalog->checkFunction(
'ILLRequests',
[
'id' => $driver->getUniqueID(),
'patron' => $patron,
]
);
if (!$checkRequests) {
return $this->redirectToRecord();
}
// Do we have valid information?
// Sets $this->logonURL and $this->gatheredDetails
$gatheredDetails = $this->ILLRequests()->validateRequest(
$checkRequests['HMACKeys']
);
if (!$gatheredDetails) {
return $this->redirectToRecord();
}
// Block invalid requests:
$validRequest = $catalog->checkILLRequestIsValid(
$driver->getUniqueID(),
$gatheredDetails,
$patron
);
if ((is_array($validRequest) && !$validRequest['valid']) || !$validRequest) {
$this->flashMessenger()->addErrorMessage(
is_array($validRequest)
? $validRequest['status'] : 'ill_request_error_blocked'
);
return $this->redirectToRecord('#top');
}
// Send various values to the view so we can build the form:
$extraFields = isset($checkRequests['extraFields'])
? explode(':', $checkRequests['extraFields']) : [];
// Process form submissions if necessary:
if (null !== $this->params()->fromPost('placeILLRequest')) {
// If we made it this far, we're ready to place the hold;
// if successful, we will redirect and can stop here.
// Add Patron Data to Submitted Data
$details = $gatheredDetails + ['patron' => $patron];
// Attempt to place the hold:
$function = (string)$checkRequests['function'];
$results = $catalog->$function($details);
// Success: Go to Display ILL Requests
if (isset($results['success']) && $results['success'] == true) {
$msg = [
'html' => true,
'msg' => 'ill_request_place_success_html',
'tokens' => [
'%%url%%' => $this->url()
->fromRoute('myresearch-illrequests'),
],
];
$this->flashMessenger()->addMessage($msg, 'success');
$this->getViewRenderer()->plugin('session')->put('reset_account_status', true);
return $this->redirectToRecord($this->inLightbox() ? '?layout=lightbox' : '');
} else {
// Failure: use flash messenger to display messages, stay on
// the current form.
if (isset($results['status'])) {
$this->flashMessenger()
->addMessage($results['status'], 'error');
}
if (isset($results['sysMessage'])) {
$this->flashMessenger()
->addMessage($results['sysMessage'], 'error');
}
}
}
// Find and format the default required date:
$defaultRequiredDate = $this->ILLRequests()
->getDefaultRequiredDate($checkRequests);
$defaultRequiredDate
= $this->serviceLocator->get(\VuFind\Date\Converter::class)
->convertToDisplayDate('U', $defaultRequiredDate);
// Get pickup libraries
$pickupLibraries = $catalog->getILLPickUpLibraries(
$driver->getUniqueID(),
$patron,
$gatheredDetails
);
// Get pickup locations. Note that these are independent of pickup library,
// and library specific locations must be retrieved when a library is
// selected.
$pickupLocations = $catalog->getPickUpLocations($patron, $gatheredDetails);
// Check that there are pick up locations to choose from if the field is
// required:
if (in_array('pickUpLocation', $extraFields) && !$pickupLocations) {
$this->flashMessenger()
->addErrorMessage('No pickup locations available');
return $this->redirectToRecord('#top');
}
$config = $this->getConfig();
$homeLibrary = ($config->Account->set_home_library ?? true)
? $this->getUser()->getHomeLibrary() : '';
// helpText is only for backward compatibility:
$helpText = $helpTextHtml = $checkRequests['helpText'];
$view = $this->createViewModel(
compact(
'gatheredDetails',
'pickupLibraries',
'pickupLocations',
'homeLibrary',
'extraFields',
'defaultRequiredDate',
'helpText',
'helpTextHtml'
)
);
$view->setTemplate('record/illrequest');
return $view;
}
}