Page MenuHomeWickedGov Phorge
Files F4071426

ConsequenceGetMessageTestTrait.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

ConsequenceGetMessageTestTrait.php
View Options

<?php
use MediaWiki\Extension\AbuseFilter\ActionSpecifier;
use MediaWiki\Extension\AbuseFilter\Consequences\Consequence\HookAborterConsequence;
use MediaWiki\Extension\AbuseFilter\Consequences\Parameters;
use MediaWiki\Extension\AbuseFilter\Filter\ExistingFilter;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\User\UserIdentity;
use MediaWiki\User\UserIdentityValue;
use PHPUnit\Framework\MockObject\MockObject;
/**
* @method MockObject createMock($class)
* @method assertSame($x,$y,$msg='')
* @method assertStringMatchesFormat($fmt,$str,$msg='')
*/
trait ConsequenceGetMessageTestTrait {
/**
* @param UserIdentity|string|null $user Test name when used as data provider, a UserIdentity can be passed when
* called explicitly
* @return Generator
*/
public function provideGetMessageParameters( $user = null ): Generator {
$user = $user instanceof UserIdentity
? $user
: new UserIdentityValue( 1, 'getMessage test user' );
$localFilter = $this->createMock( ExistingFilter::class );
$localFilter->method( 'getID' )->willReturn( 1 );
$localFilter->method( 'getName' )->willReturn( 'Local filter' );
$localParams = new Parameters(
$localFilter,
false,
new ActionSpecifier(
'edit',
$this->createMock( LinkTarget::class ),
$user,
'1.2.3.4',
null
)
);
yield 'local filter' => [ $localParams ];
$globalFilter = $this->createMock( ExistingFilter::class );
$globalFilter->method( 'getID' )->willReturn( 3 );
$globalFilter->method( 'getName' )->willReturn( 'Global filter' );
$globalParams = new Parameters(
$globalFilter,
true,
new ActionSpecifier(
'edit',
$this->createMock( LinkTarget::class ),
$user,
'1.2.3.4',
null
)
);
yield 'global filter' => [ $globalParams ];
}
/**
* @param HookAborterConsequence $consequence
* @param Parameters $params
* @param string $msg
*/
protected function doTestGetMessage(
HookAborterConsequence $consequence,
Parameters $params,
string $msg
): void {
$actualMsg = $consequence->getMessage();
$this->assertSame( $msg, $actualMsg[0], 'message' );
$this->assertSame( $params->getFilter()->getName(), $actualMsg[1], 'name' );
$format = $params->getIsGlobalFilter() ? 'global-%d' : '%d';
$this->assertStringMatchesFormat( $format, $actualMsg[2], 'global name' );
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 17 2026, 03:56 (11 w, 4 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
1f/79/c734651b43f18d3b0d107c704e8c
Default Alt Text
ConsequenceGetMessageTestTrait.php (2 KB)

Event Timeline