Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F6087419
LocalUserOptionsStore.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
3 KB
Referenced Files
None
Subscribers
None
LocalUserOptionsStore.php
View Options
<?php
namespace
MediaWiki\User\Options
;
use
MediaWiki\HookContainer\HookRunner
;
use
MediaWiki\User\UserIdentity
;
use
Wikimedia\Rdbms\DBAccessObjectUtils
;
use
Wikimedia\Rdbms\IConnectionProvider
;
use
Wikimedia\Rdbms\IDBAccessObject
;
class
LocalUserOptionsStore
implements
UserOptionsStore
{
private
IConnectionProvider
$dbProvider
;
private
HookRunner
$hookRunner
;
/** @var array[] Cached options for each user, by user ID */
private
array
$optionsFromDb
;
public
function
__construct
(
IConnectionProvider
$dbProvider
,
HookRunner
$hookRunner
)
{
$this
->
dbProvider
=
$dbProvider
;
$this
->
hookRunner
=
$hookRunner
;
}
public
function
fetch
(
UserIdentity
$user
,
int
$recency
):
array
{
// In core, only users with local accounts may have preferences
if
(
!
$user
->
getId
()
)
{
return
[];
}
$dbr
=
DBAccessObjectUtils
::
getDBFromRecency
(
$this
->
dbProvider
,
$recency
);
$res
=
$dbr
->
newSelectQueryBuilder
()
->
select
(
[
'up_property'
,
'up_value'
]
)
->
from
(
'user_properties'
)
->
where
(
[
'up_user'
=>
$user
->
getId
()
]
)
->
recency
(
$recency
)
->
caller
(
__METHOD__
)->
fetchResultSet
();
$options
=
[];
foreach
(
$res
as
$row
)
{
$options
[
$row
->
up_property
]
=
(
string
)
$row
->
up_value
;
}
$this
->
optionsFromDb
[
$user
->
getId
()]
=
$options
;
return
$options
;
}
/** @inheritDoc */
public
function
fetchBatchForUserNames
(
array
$keys
,
array
$userNames
)
{
if
(
!
$keys
||
!
$userNames
)
{
return
[];
}
$options
=
[];
$res
=
$this
->
dbProvider
->
getReplicaDatabase
()
->
newSelectQueryBuilder
()
->
select
(
[
'user_name'
,
'up_property'
,
'up_value'
]
)
->
from
(
'user_properties'
)
->
join
(
'user'
,
null
,
'user_id=up_user'
)
->
where
(
[
'up_property'
=>
$keys
,
'user_name'
=>
$userNames
]
)
->
caller
(
__METHOD__
)
->
fetchResultSet
();
foreach
(
$res
as
$row
)
{
$options
[
$row
->
up_property
][
$row
->
user_name
]
=
(
string
)
$row
->
up_value
;
}
return
$options
;
}
/** @inheritDoc */
public
function
store
(
UserIdentity
$user
,
array
$updates
)
{
// In core, only users with local accounts may have preferences
if
(
!
$user
->
getId
()
)
{
return
false
;
}
$oldOptions
=
$this
->
optionsFromDb
[
$user
->
getId
()
]
??
$this
->
fetch
(
$user
,
IDBAccessObject
::
READ_LATEST
);
$newOptions
=
$oldOptions
;
$keysToDelete
=
[];
$rowsToInsert
=
[];
foreach
(
$updates
as
$key
=>
$value
)
{
if
(
!
UserOptionsManager
::
isValueEqual
(
$value
,
$oldOptions
[
$key
]
??
null
)
)
{
// Update by deleting and reinserting
if
(
array_key_exists
(
$key
,
$oldOptions
)
)
{
$keysToDelete
[]
=
$key
;
unset
(
$newOptions
[
$key
]
);
}
if
(
$value
!==
null
)
{
$truncValue
=
mb_strcut
(
$value
,
0
,
UserOptionsManager
::
MAX_BYTES_OPTION_VALUE
);
$rowsToInsert
[]
=
[
'up_user'
=>
$user
->
getId
(),
'up_property'
=>
$key
,
'up_value'
=>
$truncValue
,
];
$newOptions
[
$key
]
=
$truncValue
;
}
}
}
if
(
!
count
(
$keysToDelete
)
&&
!
count
(
$rowsToInsert
)
)
{
// Nothing to do
return
false
;
}
// Do the DELETE
$dbw
=
$this
->
dbProvider
->
getPrimaryDatabase
();
if
(
$keysToDelete
)
{
$dbw
->
newDeleteQueryBuilder
()
->
deleteFrom
(
'user_properties'
)
->
where
(
[
'up_user'
=>
$user
->
getId
()
]
)
->
andWhere
(
[
'up_property'
=>
$keysToDelete
]
)
->
caller
(
__METHOD__
)->
execute
();
}
if
(
$rowsToInsert
)
{
// Insert the new preference rows
$dbw
->
newInsertQueryBuilder
()
->
insertInto
(
'user_properties'
)
->
ignore
()
->
rows
(
$rowsToInsert
)
->
caller
(
__METHOD__
)->
execute
();
}
// Update cache
$this
->
optionsFromDb
[
$user
->
getId
()]
=
$newOptions
;
$this
->
hookRunner
->
onLocalUserOptionsStoreSave
(
$user
,
$oldOptions
,
$newOptions
);
return
true
;
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Oct 5 2026, 15:12 (6 w, 1 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
d9/8c/527e50ae55c6c0f365ad12bfe75e
Default Alt Text
LocalUserOptionsStore.php (3 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment