Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F6002985
ReplaceQueryBuilder.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
5 KB
Referenced Files
None
Subscribers
None
ReplaceQueryBuilder.php
View Options
<?php
namespace
Wikimedia\Rdbms
;
use
InvalidArgumentException
;
use
UnexpectedValueException
;
/**
* Build REPLACE queries with a fluent interface.
*
* Each query builder object must be used for a single database query only,
* and not be reused afterwards. To run multiple similar queries, you can
* create a query builder to set up most of your query, which you can use
* as a "template" to clone. You can then modify the cloned object for
* each individual query.
*
* @since 1.41
* @stable to extend
* @ingroup Database
*/
class
ReplaceQueryBuilder
{
/**
* @var string The table name to be passed to IDatabase::replace()
*/
private
$table
=
''
;
/**
* @var list<array> The rows to be passed to IDatabase::replace()
*/
private
$rows
=
[];
/**
* @var string The caller (function name) to be passed to IDatabase::replace()
*/
private
$caller
=
__CLASS__
;
/**
* @var string[] The unique keys to be passed to IDatabase::replace()
*/
private
$uniqueIndexFields
=
[];
/** @var IDatabase */
protected
$db
;
/**
* Only for use in subclasses. To create a ReplaceQueryBuilder instance,
* use `$db->newReplaceQueryBuilder()` instead.
*
* @param IDatabase $db
*/
public
function
__construct
(
IDatabase
$db
)
{
$this
->
db
=
$db
;
}
/**
* Change the IDatabase object the query builder is bound to. The specified
* IDatabase will subsequently be used to execute the query.
*
* @param IDatabase $db
* @return $this
*/
public
function
connection
(
IDatabase
$db
)
{
if
(
$this
->
db
->
getType
()
!==
$db
->
getType
()
)
{
throw
new
InvalidArgumentException
(
__METHOD__
.
' cannot switch to a database of a different type.'
);
}
$this
->
db
=
$db
;
return
$this
;
}
/**
* Set the query parameters to the given values, appending to the values
* which were already set. This can be used to interface with legacy code.
* If a key is omitted, the previous value will be retained.
*
* The parameters must be formatted as required by Database::replace.
*
* @param array $info Associative array of query info, with keys:
* - table: The table name to be passed to Database::replace()
* - rows: The rows to be inserted
* - options: The query options
* - caller: The caller signature
*
* @return $this
*/
public
function
queryInfo
(
$info
)
{
if
(
isset
(
$info
[
'table'
]
)
)
{
$this
->
table
(
$info
[
'table'
]
);
}
if
(
isset
(
$info
[
'rows'
]
)
)
{
$this
->
rows
(
$info
[
'rows'
]
);
}
if
(
isset
(
$info
[
'uniqueIndexFields'
]
)
)
{
$this
->
uniqueIndexFields
(
(
array
)
$info
[
'uniqueIndexFields'
]
);
}
if
(
isset
(
$info
[
'caller'
]
)
)
{
$this
->
caller
(
$info
[
'caller'
]
);
}
return
$this
;
}
/**
* Manually set the table name to be passed to IDatabase::replace()
*
* @param string $table The unqualified name of a table
* @param-taint $table exec_sql
* @return $this
*/
public
function
table
(
$table
)
{
$this
->
table
=
$table
;
return
$this
;
}
/**
* Set table for the query. Alias for table().
*
* @param string $table The unqualified name of a table
* @param-taint $table exec_sql
* @return $this
*/
public
function
replaceInto
(
string
$table
)
{
return
$this
->
table
(
$table
);
}
/**
* Add rows to be inserted.
*
* @param list<array> $rows
* $rows should be an integer-keyed list of such string-keyed maps, defining a list of new rows.
* The keys in each map must be identical to each other and in the same order.
* The rows must not collide with each other.
*
* @return $this
*/
public
function
rows
(
array
$rows
)
{
$this
->
rows
=
array_merge
(
$this
->
rows
,
$rows
);
return
$this
;
}
/**
* Add one row to be inserted.
*
* @param array $row
* $row must be a string-keyed map of (column name => value) defining a new row. Values are
* treated as literals and quoted appropriately; null is interpreted as NULL.
*
* @return $this
*/
public
function
row
(
array
$row
)
{
$this
->
rows
[]
=
$row
;
return
$this
;
}
/**
* Set the unique index fields
*
* @param string|string[] $uniqueIndexFields
* @return $this
*/
public
function
uniqueIndexFields
(
$uniqueIndexFields
)
{
if
(
is_string
(
$uniqueIndexFields
)
)
{
$uniqueIndexFields
=
[
$uniqueIndexFields
];
}
$this
->
uniqueIndexFields
=
$uniqueIndexFields
;
return
$this
;
}
/**
* Set the method name to be included in an SQL comment.
*
* @param string $fname
* @param-taint $fname exec_sql
* @return $this
*/
public
function
caller
(
$fname
)
{
$this
->
caller
=
$fname
;
return
$this
;
}
/**
* Run the constructed REPLACE query and return the result.
*/
public
function
execute
()
{
if
(
!
$this
->
rows
)
{
throw
new
UnexpectedValueException
(
__METHOD__
.
' can
\'
t have empty $rows value'
);
}
if
(
$this
->
table
===
''
)
{
throw
new
UnexpectedValueException
(
__METHOD__
.
' expects table not to be empty'
);
}
if
(
!
$this
->
uniqueIndexFields
)
{
throw
new
UnexpectedValueException
(
__METHOD__
.
' expects unique key to be provided'
);
}
$this
->
db
->
replace
(
$this
->
table
,
[
$this
->
uniqueIndexFields
],
$this
->
rows
,
$this
->
caller
);
}
/**
* Get an associative array describing the query in terms of its raw parameters to
* Database::replace(). This can be used to interface with legacy code.
*
* @return array The query info array, with keys:
* - table: The table name
* - rows: The rows array
* - options: The query options
* - caller: The caller signature
*/
public
function
getQueryInfo
()
{
$info
=
[
'table'
=>
$this
->
table
,
'rows'
=>
$this
->
rows
,
'uniqueIndexFields'
=>
$this
->
uniqueIndexFields
,
];
if
(
$this
->
caller
!==
__CLASS__
)
{
$info
[
'caller'
]
=
$this
->
caller
;
}
return
$info
;
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Oct 4 2026, 07:00 (6 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
71/cc/01f2e83d91fa79c51c9f6b12cee2
Default Alt Text
ReplaceQueryBuilder.php (5 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment