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 interface. |
5 | * |
6 | * PHP version 7 |
7 | * |
8 | * Copyright (C) The National Library of Finland 2020. |
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 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 SerializationInterface |
42 | { |
43 | /** |
44 | * Check if the serialization class can parse the given MARC string |
45 | * |
46 | * @param string $marc MARC |
47 | * |
48 | * @return bool |
49 | */ |
50 | public static function canParse(string $marc): bool; |
51 | |
52 | /** |
53 | * Check if the serialization class can parse the given MARC collection string |
54 | * |
55 | * @param string $marc MARC |
56 | * |
57 | * @return bool |
58 | */ |
59 | public static function canParseCollection(string $marc): bool; |
60 | |
61 | /** |
62 | * Parse MARC collection from a string into an array of MarcReader classes |
63 | * |
64 | * @param string $collection MARC record collection in the format supported by |
65 | * the serialization class |
66 | * |
67 | * @throws Exception |
68 | * @return array |
69 | */ |
70 | public static function collectionFromString(string $collection): array; |
71 | |
72 | /** |
73 | * Parse MARC from a string |
74 | * |
75 | * @param string $marc MARC record in the format supported by the serialization |
76 | * class |
77 | * |
78 | * @throws Exception |
79 | * @return array |
80 | */ |
81 | public static function fromString(string $marc): array; |
82 | |
83 | /** |
84 | * Convert record to a string representing the format supported by the |
85 | * serialization class |
86 | * |
87 | * @param array $data Record data |
88 | * |
89 | * @return string |
90 | */ |
91 | public static function toString(array $data): string; |
92 | } |