Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 22
0.00% covered (danger)
0.00%
0 / 4
CRAP
0.00% covered (danger)
0.00%
0 / 1
DBAccessObjectUtils
0.00% covered (danger)
0.00%
0 / 22
0.00% covered (danger)
0.00%
0 / 4
132
0.00% covered (danger)
0.00%
0 / 1
 hasFlags
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getDBOptions
0.00% covered (danger)
0.00%
0 / 12
0.00% covered (danger)
0.00%
0 / 1
30
 getDBFromIndex
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
12
 getDBFromRecency
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
6
1<?php
2/**
3 * This file contains database access object related constants.
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 Database
22 */
23
24use Wikimedia\Rdbms\IConnectionProvider;
25use Wikimedia\Rdbms\IReadableDatabase;
26
27/**
28 * Helper class for DAO classes
29 *
30 * @since 1.26
31 */
32class DBAccessObjectUtils implements IDBAccessObject {
33    /**
34     * @param int $bitfield
35     * @param int $flags IDBAccessObject::READ_* constant
36     * @return bool Bitfield has flag $flag set
37     */
38    public static function hasFlags( $bitfield, $flags ) {
39        return ( $bitfield & $flags ) == $flags;
40    }
41
42    /**
43     * Get an appropriate DB index and options
44     *
45     * @deprecated since 1.43
46     * @param int $bitfield Bitfield of IDBAccessObject::READ_* constants
47     * @return array List of DB indexes and options in this order:
48     *   - DB_PRIMARY or DB_REPLICA constant for the initial query
49     *   - SELECT options array for the initial query
50     */
51    public static function getDBOptions( $bitfield ) {
52        wfDeprecated( __METHOD__, '1.43' );
53        if ( self::hasFlags( $bitfield, IDBAccessObject::READ_LATEST_IMMUTABLE ) ) {
54            $index = DB_REPLICA; // override READ_LATEST if set
55        } elseif ( self::hasFlags( $bitfield, IDBAccessObject::READ_LATEST ) ) {
56            $index = DB_PRIMARY;
57        } else {
58            $index = DB_REPLICA;
59        }
60
61        $lockingOptions = [];
62        if ( self::hasFlags( $bitfield, IDBAccessObject::READ_EXCLUSIVE ) ) {
63            $lockingOptions[] = 'FOR UPDATE';
64        } elseif ( self::hasFlags( $bitfield, IDBAccessObject::READ_LOCKING ) ) {
65            $lockingOptions[] = 'LOCK IN SHARE MODE';
66        }
67
68        return [ $index, $lockingOptions ];
69    }
70
71    /**
72     * Takes $index from ::getDBOptions() and return proper Database object
73     *
74     * @deprecated since 1.42
75     *
76     * @param IConnectionProvider $dbProvider
77     * @param int $index either DB_REPLICA or DB_PRIMARY
78     * @return IReadableDatabase
79     */
80    public static function getDBFromIndex( IConnectionProvider $dbProvider, int $index ): IReadableDatabase {
81        wfDeprecated( __METHOD__, '1.42' );
82        if ( $index === DB_PRIMARY ) {
83            return $dbProvider->getPrimaryDatabase();
84        } elseif ( $index === DB_REPLICA ) {
85            return $dbProvider->getReplicaDatabase();
86        } else {
87            throw new InvalidArgumentException( '$index must be either DB_REPLICA or DB_PRIMARY' );
88        }
89    }
90
91    /**
92     * @param IConnectionProvider $dbProvider
93     * @param int $recency IDBAccessObject::READ_* constant
94     * @return IReadableDatabase
95     * @since 1.42
96     */
97    public static function getDBFromRecency( IConnectionProvider $dbProvider, int $recency ): IReadableDatabase {
98        if ( self::hasFlags( $recency, IDBAccessObject::READ_LATEST ) ) {
99            return $dbProvider->getPrimaryDatabase();
100        }
101        return $dbProvider->getReplicaDatabase();
102    }
103}