Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

RevisionStore: add INCLUDE_* constants

Browse source 
As the same string values are used by multiple methods in
RevisionStore, factoring them out to constants would make sense.

The only other appearances of these strings in core are some
long-deprecated methods that are probably not worth updating.

Change-Id: I85fe6ab96716f237291202dbb1ebefb90bb9f0da
This commit is contained in:
Ostrzyciel 2020-08-17 20:22:17 +02:00
parent a21774a721
commit 13dfd35895
3 changed files with 33 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
includes/Revision/RevisionStore.php
View file

@ -85,6 +85,11 @@ class RevisionStore
public const ORDER_OLDEST_TO_NEWEST = 'ASC';
public const ORDER_NEWEST_TO_OLDEST = 'DESC';
// Constants for get(...)Between methods
public const INCLUDE_OLD = 'include_old';
public const INCLUDE_NEW = 'include_new';
public const INCLUDE_BOTH = 'include_both';
/**
* @var SqlBlobStore
*/
@ -3047,9 +3052,9 @@ class RevisionStore
* @param RevisionRecord|null $new New revision.
* If null is provided, count until the last revision (inclusive).
* @param string|array $options Single option, or an array of options:
* 'include_old' Include $old in the range; $new is excluded.
* 'include_new' Include $new in the range; $old is excluded.
* 'include_both' Include both $old and $new in the range.
* RevisionStore::INCLUDE_OLD Include $old in the range; $new is excluded.
* RevisionStore::INCLUDE_NEW Include $new in the range; $old is excluded.
* RevisionStore::INCLUDE_BOTH Include both $old and $new in the range.
* @return array
*/
private function getRevisionLimitConditions(
@ -3061,13 +3066,13 @@ class RevisionStore
$options = (array)$options;
$oldCmp = '>';
$newCmp = '<';
if ( in_array( 'include_old', $options ) ) {
if ( in_array( self::INCLUDE_OLD, $options ) ) {
$oldCmp = '>=';
}
if ( in_array( 'include_new', $options ) ) {
if ( in_array( self::INCLUDE_NEW, $options ) ) {
$newCmp = '<=';
}
if ( in_array( 'include_both', $options ) ) {
if ( in_array( self::INCLUDE_BOTH, $options ) ) {
$oldCmp = '>=';
$newCmp = '<=';
}
@ -3099,9 +3104,9 @@ class RevisionStore
* @param int|null $max Limit of Revisions to count, will be incremented by
* one to detect truncations.
* @param string|array $options Single option, or an array of options:
* 'include_old' Include $old in the range; $new is excluded.
* 'include_new' Include $new in the range; $old is excluded.
* 'include_both' Include both $old and $new in the range.
* RevisionStore::INCLUDE_OLD Include $old in the range; $new is excluded.
* RevisionStore::INCLUDE_NEW Include $new in the range; $old is excluded.
* RevisionStore::INCLUDE_BOTH Include both $old and $new in the range.
* @param string|null $order The direction in which the revisions should be sorted.
* Possible values:
* - RevisionStore::ORDER_OLDEST_TO_NEWEST
@ -3125,10 +3130,10 @@ class RevisionStore
$this->assertRevisionParameter( 'new', $pageId, $new );
$options = (array)$options;
$includeOld = in_array( 'include_old', $options ) ||
in_array( 'include_both', $options );
$includeNew = in_array( 'include_new', $options ) ||
in_array( 'include_both', $options );
$includeOld = in_array( self::INCLUDE_OLD, $options ) ||
in_array( self::INCLUDE_BOTH, $options );
$includeNew = in_array( self::INCLUDE_NEW, $options ) ||
in_array( self::INCLUDE_BOTH, $options );
// No DB query needed if old and new are the same revision.
// Can't check for consecutive revisions with 'getParentId' for a similar
@ -3179,9 +3184,9 @@ class RevisionStore
* @param User|null $user the user who's access rights to apply
* @param int|null $max Limit of Revisions to count, will be incremented to detect truncations.
* @param string|array $options Single option, or an array of options:
* 'include_old' Include $old in the range; $new is excluded.
* 'include_new' Include $new in the range; $old is excluded.
* 'include_both' Include both $old and $new in the range.
* RevisionStore::INCLUDE_OLD Include $old in the range; $new is excluded.
* RevisionStore::INCLUDE_NEW Include $new in the range; $old is excluded.
* RevisionStore::INCLUDE_BOTH Include both $old and $new in the range.
* @throws InvalidArgumentException in case either revision is unsaved or
* the revisions do not belong to the same page or unknown option is passed.
* @return UserIdentity[] Names of revision authors in the range
@ -3250,9 +3255,9 @@ class RevisionStore
* @param User|null $user the user who's access rights to apply
* @param int|null $max Limit of Revisions to count, will be incremented to detect truncations.
* @param string|array $options Single option, or an array of options:
* 'include_old' Include $old in the range; $new is excluded.
* 'include_new' Include $new in the range; $old is excluded.
* 'include_both' Include both $old and $new in the range.
* RevisionStore::INCLUDE_OLD Include $old in the range; $new is excluded.
* RevisionStore::INCLUDE_NEW Include $new in the range; $old is excluded.
* RevisionStore::INCLUDE_BOTH Include both $old and $new in the range.
* @throws InvalidArgumentException in case either revision is unsaved or
* the revisions do not belong to the same page or unknown option is passed.
* @return int Number of revisions authors in the range.
@ -3283,9 +3288,9 @@ class RevisionStore
* If null is provided, count until the last revision (inclusive).
* @param int|null $max Limit of Revisions to count, will be incremented to detect truncations.
* @param string|array $options Single option, or an array of options:
* 'include_old' Include $old in the range; $new is excluded.
* 'include_new' Include $new in the range; $old is excluded.
* 'include_both' Include both $old and $new in the range.
* RevisionStore::INCLUDE_OLD Include $old in the range; $new is excluded.
* RevisionStore::INCLUDE_NEW Include $new in the range; $old is excluded.
* RevisionStore::INCLUDE_BOTH Include both $old and $new in the range.
* @throws InvalidArgumentException in case either revision is unsaved or
* the revisions do not belong to the same page.
* @return int Number of revisions between these revisions.

3
includes/skins/Skin.php
View file

@ -23,6 +23,7 @@
use MediaWiki\HookContainer\ProtectedHookAccessorTrait;
use MediaWiki\MediaWikiServices;
use MediaWiki\Revision\RevisionLookup;
use MediaWiki\Revision\RevisionStore;
use Wikimedia\WrappedString;
use Wikimedia\WrappedStringList;
@ -1837,7 +1838,7 @@ abstract class Skin extends ContextSource {
$latestRev,
null,
10,
'include_new'
RevisionStore::INCLUDE_NEW
);
}
} else {

8
tests/phpunit/includes/Revision/RevisionStoreDbTestBase.php
View file

@ -2545,7 +2545,7 @@ abstract class RevisionStoreDbTestBase extends MediaWikiIntegrationTestCase {
$revisions[0],
$revisions[$NUM - 2],
null,
'include_new'
RevisionStore::INCLUDE_NEW
),
'The inclusion string options are respected'
);
@ -2556,7 +2556,7 @@ abstract class RevisionStoreDbTestBase extends MediaWikiIntegrationTestCase {
$revisions[0],
$revisions[$NUM - 2],
null,
[ 'include_both' ]
[ RevisionStore::INCLUDE_BOTH ]
),
false,
false,
@ -2622,11 +2622,11 @@ abstract class RevisionStoreDbTestBase extends MediaWikiIntegrationTestCase {
'The count is non-inclusive on both ends if both beginning and end are provided' );
$this->assertEquals( $NUM - 2,
$revisionStore->countRevisionsBetween( $page->getId(), $revisions[0], $revisions[$NUM - 2],
null, 'include_new' ),
null, RevisionStore::INCLUDE_NEW ),
'The count string options are respected' );
$this->assertEquals( $NUM - 1,
$revisionStore->countRevisionsBetween( $page->getId(), $revisions[0], $revisions[$NUM - 2],
null, [ 'include_both' ] ),
null, [ RevisionStore::INCLUDE_BOTH ] ),
'The count array options are respected' );
$this->assertEquals( $NUM - 1,
$revisionStore->countRevisionsBetween( $page->getId(), $revisions[0] ),