Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 4 |
|
0.00% |
0 / 2 |
CRAP | |
0.00% |
0 / 1 |
| ConfigPathTrait | |
0.00% |
0 / 4 |
|
0.00% |
0 / 2 |
6 | |
0.00% |
0 / 1 |
| getBaseConfigFilePath | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
2 | |||
| getForcedLocalConfigPath | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
2 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * VuFind Action Feature Trait - Configuration file path methods |
| 5 | * |
| 6 | * PHP version 8 |
| 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 Controller_Plugins |
| 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 Page |
| 28 | */ |
| 29 | |
| 30 | namespace VuFind\Controller\Feature; |
| 31 | |
| 32 | /** |
| 33 | * VuFind Action Feature Trait - Configuration file path methods |
| 34 | * |
| 35 | * @category VuFind |
| 36 | * @package Controller_Plugins |
| 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 Page |
| 40 | */ |
| 41 | trait ConfigPathTrait |
| 42 | { |
| 43 | /** |
| 44 | * Get path to base configuration file |
| 45 | * |
| 46 | * @param string $filename Configuration file name |
| 47 | * |
| 48 | * @return string |
| 49 | */ |
| 50 | protected function getBaseConfigFilePath(string $filename): string |
| 51 | { |
| 52 | $resolver = $this->getService(\VuFind\Config\PathResolver::class); |
| 53 | return $resolver->getBaseConfigPath($filename); |
| 54 | } |
| 55 | |
| 56 | /** |
| 57 | * Get path to local configuration file (even if it does not yet exist) |
| 58 | * |
| 59 | * @param string $filename Configuration file name |
| 60 | * |
| 61 | * @return string |
| 62 | */ |
| 63 | protected function getForcedLocalConfigPath(string $filename): string |
| 64 | { |
| 65 | $resolver = $this->getService(\VuFind\Config\PathResolver::class); |
| 66 | return $resolver->getLocalConfigPath($filename, null, true); |
| 67 | } |
| 68 | } |