Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3/**
4 * AJAX handler interface
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2018.
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 * AJAX handler interface
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 */
43interface AjaxHandlerInterface
44{
45    // define some status constants
46    public const STATUS_HTTP_BAD_REQUEST = 400; // bad request
47    public const STATUS_HTTP_NEED_AUTH = 401;   // must login first
48    public const STATUS_HTTP_FORBIDDEN = 403;   // method is unavailable
49    public const STATUS_HTTP_ERROR = 500;       // an error occurred
50    public const STATUS_HTTP_UNAVAILABLE = 503; // temporarily unavailable
51
52    /**
53     * Handle a request.
54     *
55     * @param Params $params Parameter helper from controller
56     *
57     * @return array [response data, HTTP status code]
58     */
59    public function handleRequest(Params $params);
60}