Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
2 / 2
CRAP
100.00% covered (success)
100.00%
1 / 1
AbstractSerializationFile
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
2 / 2
3
100.00% covered (success)
100.00%
1 / 1
 setMessageCallback
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 message
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
2
1<?php
2
3/**
4 * Abstract base class for serialization format support classes.
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
30namespace VuFind\Marc\Serialization;
31
32use function call_user_func;
33
34/**
35 * Abstract base class for serialization format support classes.
36 *
37 * @category VuFind
38 * @package  MARC
39 * @author   Ere Maijala <ere.maijala@helsinki.fi>
40 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
41 * @link     https://vufind.org/wiki/development:plugins:record_drivers Wiki
42 */
43abstract class AbstractSerializationFile implements
44    SerializationFileInterface,
45    MessageCallbackInterface
46{
47    /**
48     * Message callback
49     *
50     * @var callable
51     */
52    protected $messageCallback = null;
53
54    /**
55     * Set message callback
56     *
57     * @param callable $callback Message callback
58     *
59     * @return void
60     */
61    public function setMessageCallback(?callable $callback): void
62    {
63        $this->messageCallback = $callback;
64    }
65
66    /**
67     * Output a message
68     *
69     * @param string $msg   Message
70     * @param int    $level Error level (see
71     * https://www.php.net/manual/en/function.error-reporting.php)
72     *
73     * @return void
74     */
75    protected function message(string $msg, int $level): void
76    {
77        if (null !== $this->messageCallback) {
78            call_user_func($this->messageCallback, $msg, $level);
79        }
80    }
81}