-
Notifications
You must be signed in to change notification settings - Fork 4
/
MarcCollectionFile.php
187 lines (173 loc) · 4.71 KB
/
MarcCollectionFile.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
<?php
/**
* MARC collection class for streaming a file.
*
* PHP version 7
*
* Copyright (C) The National Library of Finland 2022.
*
* 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 MARC
* @author Ere Maijala <ere.maijala@helsinki.fi>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link https://vufind.org/wiki/development Wiki
*/
namespace VuFind\Marc;
/**
* MARC collection class for streaming a file.
*
* @category VuFind
* @package MARC
* @author Ere Maijala <ere.maijala@helsinki.fi>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link https://vufind.org/wiki/development Wiki
*/
class MarcCollectionFile implements \Iterator
{
/**
* Supported serialization formats
*
* @var array
*/
protected $serializations = [
'ISO2709' => Serialization\Iso2709::class,
'MARCXML' => Serialization\MarcXml::class,
'JSON' => Serialization\MarcInJson::class,
];
/**
* Serialized format stream
*
* @var Serialization\SerializationFileInterface
*/
protected $stream;
/**
* Iteration position
*
* @var int
*/
protected $position = 0;
/**
* Current record
*
* @var string
*/
protected $record = '';
/**
* Message callback
*
* @var callable
*/
protected $messageCallback;
/**
* Constructor
*
* @param string $file MARC record collection file in MARCXML or
* ISO2709 format
* @param callable $messageCallback Callback triggered for any messages with
* message string and error level (similar to
* https://www.php.net/manual/en/function.error-reporting.php)
*/
public function __construct(string $file = '', ?callable $messageCallback = null)
{
$this->messageCallback = $messageCallback;
$this->setFile($file);
}
/**
* Set MARC record file
*
* @param string $file MARC record collection file in MARCXML or ISO2709 format
*
* @throws \Exception
* @return void
*/
public function setFile(string $file): void
{
if (!file_exists($file)) {
throw new \Exception("File '$file' does not exist");
}
$this->position = 0;
$this->record = null;
foreach ($this->serializations as $serialization) {
if ($serialization::canParseCollectionFile($file)) {
$this->stream = new $serialization();
if (
$this->stream instanceof Serialization\MessageCallbackInterface
) {
$this->stream->setMessageCallback($this->messageCallback);
}
$this->stream->openCollectionFile($file);
return;
}
}
throw new \Exception('MARC collection file format not recognized');
}
/**
* Iterator: Rewind to the beginning.
*
* @return void
*/
public function rewind(): void
{
$this->stream->rewind();
$this->position = 0;
$this->record = null;
}
/**
* Iterator: Return current record.
*
* @return mixed
*/
#[\ReturnTypeWillChange]
public function current()
{
if (null === $this->record) {
$this->record = $this->stream->getNextRecord();
}
return $this->record ? new MarcReader($this->record) : null;
}
/**
* Iterator: Return current key.
*
* @return mixed
*/
#[\ReturnTypeWillChange]
public function key()
{
return $this->position;
}
/**
* Iterator: Advance to the next record.
*
* @return void
*/
public function next(): void
{
++$this->position;
$this->record = null;
}
/**
* Iterator: Check if current position is valid.
*
* @return bool
*/
public function valid(): bool
{
if (null === $this->record) {
$this->record = $this->stream->getNextRecord();
}
return '' !== $this->record;
}
}