BatchRowWriter::__construct()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 4
nc 1
nop 3
dl 0
loc 5
rs 9.4285
c 0
b 0
f 0
1
<?php
2
/**
3
 * Updates database rows by primary key in batches.
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 Maintenance
22
 */
23
use \MediaWiki\MediaWikiServices;
24
25
class BatchRowWriter {
26
	/**
27
	 * @var IDatabase $db The database to write to
28
	 */
29
	protected $db;
30
31
	/**
32
	 * @var string $table The name of the table to update
33
	 */
34
	protected $table;
35
36
	/**
37
	 * @var string $clusterName A cluster name valid for use with LBFactory
38
	 */
39
	protected $clusterName;
40
41
	/**
42
	 * @param IDatabase $db The database to write to
43
	 * @param string       $table       The name of the table to update
44
	 * @param string|bool  $clusterName A cluster name valid for use with LBFactory
45
	 */
46
	public function __construct( IDatabase $db, $table, $clusterName = false ) {
47
		$this->db = $db;
48
		$this->table = $table;
49
		$this->clusterName = $clusterName;
0 ignored issues
show
Documentation Bug introduced by
It seems like $clusterName can also be of type boolean. However, the property $clusterName is declared as type string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
50
	}
51
52
	/**
53
	 * @param array $updates Array of arrays each containing two keys, 'primaryKey'
54
	 *  and 'changes'. primaryKey must contain a map of column names to values
55
	 *  sufficient to uniquely identify the row changes must contain a map of column
56
	 *  names to update values to apply to the row.
57
	 */
58
	public function write( array $updates ) {
59
		$lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
60
		$ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__ );
61
62
		foreach ( $updates as $update ) {
63
			$this->db->update(
64
				$this->table,
65
				$update['changes'],
66
				$update['primaryKey'],
67
				__METHOD__
68
			);
69
		}
70
71
		$lbFactory->commitAndWaitForReplication( __METHOD__, $ticket );
72
	}
73
}
74