wiki.techinc.nl/includes/editpage/SpamChecker.php
Umherirrender ea5ea60b31 Various doc fixes about false on method arguments/return types
Doc-only changes

Change-Id: I5177f582ae7ee70c357e9389fed14819faf79463
2022-11-10 19:23:46 +00:00

65 lines
1.4 KiB
PHP

<?php
namespace MediaWiki\EditPage;
/**
* Service to check if text (either content or a summary) qualifies as spam
*
* Text qualifies as spam if it matches the global $wgSpamRegex
* Summaries qualify as spam if they match the global $wgSummarySpamRegex
*
* @author DannyS712
* @since 1.35
*/
class SpamChecker {
/** @var string[] */
private $spamRegex;
/** @var string[] */
private $summaryRegex;
/**
* @param string[] $spamRegex
* @param string[] $summaryRegex
*/
public function __construct( $spamRegex, $summaryRegex ) {
$this->spamRegex = $spamRegex;
$this->summaryRegex = $summaryRegex;
}
/**
* Check whether content text is considered spam
*
* @param string $text
* @return string|false Matching string or false
*/
public function checkContent( string $text ) {
return self::checkInternal( $text, $this->spamRegex );
}
/**
* Check whether summary text is considered spam
*
* @param string $summary
* @return string|false Matching string or false
*/
public function checkSummary( string $summary ) {
return self::checkInternal( $summary, $this->summaryRegex );
}
/**
* @param string $text
* @param array $regexes
* @return string|false
*/
private static function checkInternal( string $text, array $regexes ) {
foreach ( $regexes as $regex ) {
$matches = [];
if ( preg_match( $regex, $text, $matches ) ) {
return $matches[0];
}
}
return false;
}
}