-
Notifications
You must be signed in to change notification settings - Fork 4
/
SerializationFileInterface.php
89 lines (82 loc) · 2.34 KB
/
SerializationFileInterface.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
<?php
/**
* MARC serialization file interface.
*
* 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:plugins:record_drivers Wiki
*/
namespace VuFind\Marc\Serialization;
/**
* MARC serialization file interface.
*
* @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:plugins:record_drivers Wiki
*/
interface SerializationFileInterface
{
/**
* Check if the serialization class can parse the given MARC collection file
*
* @param string $file File name
*
* @return bool
*/
public static function canParseCollectionFile(string $file): bool;
/**
* Set message callback
*
* @param callable $callback Message callback
*
* @return void
*/
public function setMessageCallback(?callable $callback): void;
/**
* Open a collection file
*
* @param string $file File name
*
* @return void
*
* @throws \Exception
*/
public function openCollectionFile(string $file): void;
/**
* Rewind the collection file
*
* @return void
*
* @throws \Exception
*/
public function rewind(): void;
/**
* Get next record from the file or an empty string on EOF
*
* @return string
*
* @throws \Exception
*/
public function getNextRecord(): string;
}