c8ec25a961
Add doc-typehints to class properties found by the PropertyDocumentation sniff to improve the documentation. Once the sniff is enabled it avoids that new code is missing type declarations. This is focused on documentation and does not change code. Change-Id: I7dec01892a987a87b1b79374a1c28f97d055e8fa
57 lines
1.3 KiB
PHP
57 lines
1.3 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Maintenance;
|
|
|
|
use Wikimedia\Rdbms\IDatabase;
|
|
|
|
/**
|
|
* Update a database while optionally writing SQL that reverses the update to
|
|
* a file.
|
|
*/
|
|
class UndoLog {
|
|
/** @var resource */
|
|
private $file;
|
|
/** @var IDatabase */
|
|
private $dbw;
|
|
|
|
/**
|
|
* @param string|null $fileName
|
|
* @param IDatabase $dbw
|
|
*/
|
|
public function __construct( $fileName, IDatabase $dbw ) {
|
|
if ( $fileName !== null ) {
|
|
$this->file = fopen( $fileName, 'a' );
|
|
if ( !$this->file ) {
|
|
throw new \RuntimeException( 'Unable to open undo log' );
|
|
}
|
|
}
|
|
$this->dbw = $dbw;
|
|
}
|
|
|
|
/**
|
|
* @param string $table
|
|
* @param array $newValues
|
|
* @param array $oldValues
|
|
* @param string $fname
|
|
* @return bool
|
|
*/
|
|
public function update( $table, array $newValues, array $oldValues, $fname ) {
|
|
$this->dbw->newUpdateQueryBuilder()
|
|
->update( $table )
|
|
->set( $newValues )
|
|
->where( $oldValues )
|
|
->caller( $fname )->execute();
|
|
|
|
$updated = (bool)$this->dbw->affectedRows();
|
|
if ( $this->file && $updated ) {
|
|
$table = $this->dbw->tableName( $table );
|
|
fwrite(
|
|
$this->file,
|
|
"UPDATE $table" .
|
|
' SET ' . $this->dbw->makeList( $oldValues, IDatabase::LIST_SET ) .
|
|
' WHERE ' . $this->dbw->makeList( $newValues, IDatabase::LIST_AND ) . ";\n"
|
|
);
|
|
}
|
|
return $updated;
|
|
}
|
|
}
|