Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 7
0.00% covered (danger)
0.00%
0 / 2
CRAP
0.00% covered (danger)
0.00%
0 / 1
ExplodeSettingTrait
0.00% covered (danger)
0.00%
0 / 7
0.00% covered (danger)
0.00%
0 / 2
20
0.00% covered (danger)
0.00%
0 / 1
 explodeSetting
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
12
 explodeListSetting
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
1<?php
2
3/**
4 * Trait providing support for converting delimited settings to arrays
5 *
6 * PHP version 8
7 *
8 * Copyright (C) The National Library of Finland 2023.
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  Config
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 Main Site
28 */
29
30namespace VuFind\Config\Feature;
31
32/**
33 * Trait providing support for converting delimited settings to arrays
34 *
35 * @category VuFind
36 * @package  Config
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 Main Site
40 */
41trait ExplodeSettingTrait
42{
43    /**
44     * Explode a delimited setting to an array
45     *
46     * @param string $value     Setting value
47     * @param bool   $trim      Whether to trim the values (disabled by default to
48     * ensure any valid blank entry does not get trimmed, and to avoid doing extra
49     * work on each execution)
50     * @param string $separator Separator
51     *
52     * @return array
53     */
54    protected function explodeSetting(
55        string $value,
56        $trim = false,
57        string $separator = ':'
58    ): array {
59        if ('' === $value) {
60            return [];
61        }
62        $result = explode($separator, $value);
63        if ($trim) {
64            $result = array_map('trim', $result);
65        }
66        return $result;
67    }
68
69    /**
70     * Explode a comma-delimited setting to an array of trimmed values
71     *
72     * @param string $value Setting value
73     *
74     * @return array
75     */
76    protected function explodeListSetting(string $value): array
77    {
78        return $this->explodeSetting($value, true, ',');
79    }
80}