Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
80.00% covered (warning)
80.00%
8 / 10
66.67% covered (warning)
66.67%
4 / 6
 CRAP
0.00% covered (danger)
0.00%
0 / 1
RecordCollection
80.00% covered (warning)
80.00%
8 / 10
66.67% covered (warning)
66.67%
4 / 6
 7.39
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
 1
 getTotal
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
 1
 getFacets
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
 1
 setFacets
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
 2
 getOffset
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
 2
 getErrors
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
 2
1<?php
2
3/**
4 * Primo Central record collection.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2010.
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  Search
25 * @author   David Maus <maus@hab.de>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org
28 */
29
30namespace VuFindSearch\Backend\Primo\Response;
31
32use VuFindSearch\Response\AbstractRecordCollection;
33
34/**
35 * Primo Central record collection.
36 *
37 * @category VuFind
38 * @package  Search
39 * @author   David Maus <maus@hab.de>
40 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
41 * @link     https://vufind.org
42 */
43class RecordCollection extends AbstractRecordCollection
44{
45    /**
46     * Raw response.
47     *
48     * @var array
49     */
50    protected $response;
51
52    /**
53     * Constructor.
54     *
55     * @param array $response Primo response
56     *
57     * @return void
58     */
59    public function __construct(array $response)
60    {
61        $this->response = $response;
62        $this->rewind();
63    }
64
65    /**
66     * Return total number of records found.
67     *
68     * @return int
69     */
70    public function getTotal()
71    {
72        return $this->response['recordCount'] ?? 0;
73    }
74
75    /**
76     * Return available facets.
77     *
78     * Returns an associative array with the field name as key. The value is an
79     * associative array of available facets for the field, indexed by facet value.
80     *
81     * @return array
82     */
83    public function getFacets()
84    {
85        return $this->response['facets'] ?? [];
86    }
87
88    /**
89     * Set facets.
90     *
91     * @param array $facets Facet fields
92     *
93     * @return void
94     */
95    public function setFacets(array $facets): void
96    {
97        $this->response['facets'] = $facets;
98    }
99
100    /**
101     * Return offset in the total search result set.
102     *
103     * @return int
104     */
105    public function getOffset()
106    {
107        $page = isset($this->response['query']['pageNumber'])
108            ? $this->response['query']['pageNumber'] - 1 : 0;
109        $size = $this->response['query']['pageSize'] ?? 0;
110        return $page * $size;
111    }
112
113    /**
114     * Return any errors.
115     *
116     * Each error can be a translatable string or an array that the Flashmessages
117     * view helper understands.
118     *
119     * @return array
120     */
121    public function getErrors()
122    {
123        return (array)($this->response['error'] ?? []);
124    }
125}