Completed
Branch master (6c7c3c)
by Joschi
02:33
created

CachingContextLoader   A

Complexity

Total Complexity 3

Size/Duplication

Total Lines 36
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 2

Test Coverage

Coverage 100%

Importance

Changes 0
Metric Value
wmc 3
lcom 1
cbo 2
dl 0
loc 36
ccs 8
cts 8
cp 1
rs 10
c 0
b 0
f 0

2 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
A loadDocument() 0 10 2
1
<?php
2
3
/**
4
 * micrometa
5
 *
6
 * @category Jkphl
7
 * @package Jkphl\Rdfalite
8
 * @subpackage Jkphl\Micrometa\Infrastructure
9
 * @author Joschi Kuphal <[email protected]> / @jkphl
10
 * @copyright Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
11
 * @license http://opensource.org/licenses/MIT The MIT License (MIT)
12
 */
13
14
/***********************************************************************************
15
 *  The MIT License (MIT)
16
 *
17
 *  Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
18
 *
19
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
20
 *  this software and associated documentation files (the "Software"), to deal in
21
 *  the Software without restriction, including without limitation the rights to
22
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23
 *  the Software, and to permit persons to whom the Software is furnished to do so,
24
 *  subject to the following conditions:
25
 *
26
 *  The above copyright notice and this permission notice shall be included in all
27
 *  copies or substantial portions of the Software.
28
 *
29
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35
 ***********************************************************************************/
36
37
namespace Jkphl\Micrometa\Infrastructure\Parser\JsonLD;
38
39
use ML\JsonLD\FileGetContentsLoader;
40
use ML\JsonLD\RemoteDocument;
41
42
/**
43
 * Cached loader for JSON-LD context
44
 *
45
 * @package Jkphl\Rdfalite
46
 * @subpackage Jkphl\Micrometa\Infrastructure\Parser\JsonLD
47
 */
48
class CachingContextLoader extends FileGetContentsLoader
49
{
50
    /**
51
     * Vocabulary cache
52
     *
53
     * @var VocabularyCache
54
     */
55
    protected $vocabularyCache;
56
57
    /**
58
     * Constructor
59
     *
60
     * @param VocabularyCache $vocabularyCache Vocabulary cache
61
     */
62 5
    public function __construct(VocabularyCache $vocabularyCache)
63
    {
64 5
        $this->vocabularyCache = $vocabularyCache;
65 5
    }
66
67
    /**
68
     * Load (and cache) a context document
69
     *
70
     * @param string $url Context URL
71
     * @return \ML\JsonLD\RemoteDocument Remote document
72
     */
73 1
    public function loadDocument($url)
74
    {
75
        // Try to return a cached document
76 1
        $document = $this->vocabularyCache->getDocument($url);
77 1
        if ($document instanceof RemoteDocument) {
78 1
            return $document;
79
        }
80
81 1
        return $this->vocabularyCache->setDocument($url, parent::loadDocument($url));
82
    }
83
}
84