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 | * MARC serialization file interface. |
5 | * |
6 | * PHP version 7 |
7 | * |
8 | * Copyright (C) The National Library of Finland 2022. |
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 MARC |
25 | * @author Ere Maijala <ere.maijala@helsinki.fi> |
26 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
27 | * @link https://vufind.org/wiki/development:plugins:record_drivers Wiki |
28 | */ |
29 | |
30 | namespace VuFind\Marc\Serialization; |
31 | |
32 | /** |
33 | * MARC serialization file interface. |
34 | * |
35 | * @category VuFind |
36 | * @package MARC |
37 | * @author Ere Maijala <ere.maijala@helsinki.fi> |
38 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
39 | * @link https://vufind.org/wiki/development:plugins:record_drivers Wiki |
40 | */ |
41 | interface SerializationFileInterface |
42 | { |
43 | /** |
44 | * Check if the serialization class can parse the given MARC collection file |
45 | * |
46 | * @param string $file File name |
47 | * |
48 | * @return bool |
49 | */ |
50 | public static function canParseCollectionFile(string $file): bool; |
51 | |
52 | /** |
53 | * Set message callback |
54 | * |
55 | * @param callable $callback Message callback |
56 | * |
57 | * @return void |
58 | */ |
59 | public function setMessageCallback(?callable $callback): void; |
60 | |
61 | /** |
62 | * Open a collection file |
63 | * |
64 | * @param string $file File name |
65 | * |
66 | * @return void |
67 | * |
68 | * @throws \Exception |
69 | */ |
70 | public function openCollectionFile(string $file): void; |
71 | |
72 | /** |
73 | * Rewind the collection file |
74 | * |
75 | * @return void |
76 | * |
77 | * @throws \Exception |
78 | */ |
79 | public function rewind(): void; |
80 | |
81 | /** |
82 | * Get next record from the file or an empty string on EOF |
83 | * |
84 | * @return string |
85 | * |
86 | * @throws \Exception |
87 | */ |
88 | public function getNextRecord(): string; |
89 | } |