Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | |
100.00% |
2 / 2 |
|
100.00% |
1 / 1 |
CRAP | |
100.00% |
1 / 1 |
CachingDownloaderAwareTrait | |
100.00% |
2 / 2 |
|
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
setCachingDownloader | |
100.00% |
2 / 2 |
|
100.00% |
1 / 1 |
1 |
1 | <?php |
2 | |
3 | /** |
4 | * Lightweight caching downloader aware marker trait. |
5 | * |
6 | * PHP version 8 |
7 | * |
8 | * Copyright (C) Villanova University 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 Http |
25 | * @author Mario Trojan <mario.trojan@uni-tuebingen.de> |
26 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
27 | * @link https://vufind.org Main Site |
28 | */ |
29 | |
30 | namespace VuFind\Http; |
31 | |
32 | /** |
33 | * Lightweight caching downloader aware marker trait. |
34 | * |
35 | * @category VuFind |
36 | * @package Http |
37 | * @author Mario Trojan <mario.trojan@uni-tuebingen.de> |
38 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
39 | * @link https://vufind.org Main Site |
40 | */ |
41 | trait CachingDownloaderAwareTrait |
42 | { |
43 | /** |
44 | * Cache ID. This can be overridden by child classes if they want to use |
45 | * a separate cache. |
46 | * |
47 | * @var string |
48 | */ |
49 | protected $downloaderCacheId = 'downloader'; |
50 | |
51 | /** |
52 | * Cache Options Section. This can be overridden by child classes to declare |
53 | * a section in config.ini which will be parsed to override default settings. |
54 | * Note that the prefix "Cache_" will be prepended on this string. |
55 | * |
56 | * @var string |
57 | */ |
58 | protected $cacheOptionsSection = null; |
59 | |
60 | /** |
61 | * Caching downloader |
62 | * |
63 | * @var CachingDownloader |
64 | */ |
65 | protected $cachingDownloader = null; |
66 | |
67 | /** |
68 | * Set caching downloader |
69 | * |
70 | * @param $cachingDownloader CachingDownloader |
71 | * |
72 | * @return void |
73 | */ |
74 | public function setCachingDownloader(CachingDownloader $cachingDownloader) |
75 | { |
76 | $this->cachingDownloader = $cachingDownloader; |
77 | $this->cachingDownloader->setUpCache($this->downloaderCacheId, $this->cacheOptionsSection); |
78 | } |
79 | } |