Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
66.67% covered (warning)
66.67%
10 / 15
50.00% covered (danger)
50.00%
1 / 2
CRAP
0.00% covered (danger)
0.00%
0 / 1
BacklinkCacheFactory
66.67% covered (warning)
66.67%
10 / 15
50.00% covered (danger)
50.00%
1 / 2
4.59
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
2
 getBacklinkCache
100.00% covered (success)
100.00%
10 / 10
100.00% covered (success)
100.00%
1 / 1
3
1<?php
2/**
3 * Remember the page that was previously loaded.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 * @ingroup Cache
22 */
23
24namespace MediaWiki\Cache;
25
26use MediaWiki\Config\ServiceOptions;
27use MediaWiki\HookContainer\HookContainer;
28use MediaWiki\Linker\LinksMigration;
29use MediaWiki\Page\PageReference;
30use WANObjectCache;
31use Wikimedia\Rdbms\IConnectionProvider;
32
33/**
34 * @since 1.37
35 */
36class BacklinkCacheFactory {
37    /** @var BacklinkCache */
38    private $latestBacklinkCache;
39
40    /** @var WANObjectCache */
41    private $wanCache;
42
43    /** @var HookContainer */
44    private $hookContainer;
45
46    private IConnectionProvider $dbProvider;
47    private ServiceOptions $options;
48    private LinksMigration $linksMigration;
49
50    public function __construct(
51        ServiceOptions $options,
52        LinksMigration $linksMigration,
53        WANObjectCache $wanCache,
54        HookContainer $hookContainer,
55        IConnectionProvider $dbProvider
56    ) {
57        $this->options = $options;
58        $this->linksMigration = $linksMigration;
59        $this->wanCache = $wanCache;
60        $this->hookContainer = $hookContainer;
61        $this->dbProvider = $dbProvider;
62    }
63
64    /**
65     * Returns a BacklinkCache for $page. May re-use previously
66     * created instances.
67     *
68     * Currently, only one cache instance can exist; callers that
69     * need multiple backlink cache objects should keep them in scope.
70     *
71     * @param PageReference $page Page to get a backlink cache for
72     * @return BacklinkCache
73     */
74    public function getBacklinkCache( PageReference $page ): BacklinkCache {
75        if ( !$this->latestBacklinkCache || !$this->latestBacklinkCache->getPage()->isSamePageAs( $page ) ) {
76            $this->latestBacklinkCache = new BacklinkCache(
77                $this->options,
78                $this->linksMigration,
79                $this->wanCache,
80                $this->hookContainer,
81                $this->dbProvider,
82                $page
83            );
84        }
85        return $this->latestBacklinkCache;
86    }
87}