Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 24
0.00% covered (danger)
0.00%
0 / 6
CRAP
0.00% covered (danger)
0.00%
0 / 1
DependencyWrapper
0.00% covered (danger)
0.00%
0 / 24
0.00% covered (danger)
0.00%
0 / 6
210
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
6
 isExpired
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
12
 initialiseDeps
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
6
 getValue
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 storeToCache
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
2
 getValueFromCache
0.00% covered (danger)
0.00%
0 / 10
0.00% covered (danger)
0.00%
0 / 1
30
1<?php
2/**
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
17 *
18 * @file
19 */
20
21use Wikimedia\ObjectCache\BagOStuff;
22
23/**
24 * Store an arbitrary value whilst representing several CacheDependency objects as one.
25 *
26 * You should typically only use DependencyWrapper::getValueFromCache(),
27 * rather than instantiating one of these objects directly.
28 *
29 * @ingroup Language
30 */
31class DependencyWrapper {
32    private $value;
33    /** @var CacheDependency[] */
34    private $deps;
35
36    /**
37     * @param mixed $value The user-supplied value
38     * @param CacheDependency|CacheDependency[] $deps A dependency or dependency
39     *   array. All dependencies must be objects implementing CacheDependency.
40     */
41    public function __construct( $value = false, $deps = [] ) {
42        $this->value = $value;
43
44        if ( !is_array( $deps ) ) {
45            $deps = [ $deps ];
46        }
47
48        $this->deps = $deps;
49    }
50
51    /**
52     * Returns true if any of the dependencies have expired
53     *
54     * @return bool
55     */
56    public function isExpired() {
57        foreach ( $this->deps as $dep ) {
58            if ( $dep->isExpired() ) {
59                return true;
60            }
61        }
62
63        return false;
64    }
65
66    /**
67     * Initialise dependency values in preparation for storing. This must be
68     * called before serialization.
69     */
70    public function initialiseDeps() {
71        foreach ( $this->deps as $dep ) {
72            $dep->loadDependencyValues();
73        }
74    }
75
76    /**
77     * Get the user-defined value
78     * @return bool|mixed
79     */
80    public function getValue() {
81        return $this->value;
82    }
83
84    /**
85     * Store the wrapper to a cache
86     *
87     * @param BagOStuff $cache
88     * @param string $key
89     * @param int $expiry
90     */
91    public function storeToCache( $cache, $key, $expiry = 0 ) {
92        $this->initialiseDeps();
93        $cache->set( $key, $this, $expiry );
94    }
95
96    /**
97     * Attempt to get a value from the cache. If the value is expired or missing,
98     * it will be generated with the callback function (if present), and the newly
99     * calculated value will be stored to the cache in a wrapper.
100     *
101     * @param BagOStuff $cache
102     * @param string $key The cache key
103     * @param int $expiry The expiry timestamp or interval in seconds
104     * @param callable|false $callback The callback for generating the value, or false
105     * @param array $callbackParams The function parameters for the callback
106     * @param array $deps The dependencies to store on a cache miss. Note: these
107     *    are not the dependencies used on a cache hit! Cache hits use the stored
108     *    dependency array.
109     *
110     * @return mixed The value, or null if it was not present in the cache and no
111     *    callback was defined.
112     */
113    public static function getValueFromCache( $cache, $key, $expiry = 0, $callback = false,
114        $callbackParams = [], $deps = []
115    ) {
116        $obj = $cache->get( $key );
117
118        if ( is_object( $obj ) && $obj instanceof DependencyWrapper && !$obj->isExpired() ) {
119            $value = $obj->value;
120        } elseif ( $callback ) {
121            $value = $callback( ...$callbackParams );
122            # Cache the newly-generated value
123            $wrapper = new DependencyWrapper( $value, $deps );
124            $wrapper->storeToCache( $cache, $key, $expiry );
125        } else {
126            $value = null;
127        }
128
129        return $value;
130    }
131}