Pppery has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/394240 )
Change subject: Re-enable
MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic sniff
......................................................................
Re-enable MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic sniff
Bug: T170580
Change-Id: I0a0055f1de57f15a45c21e2f51ed275a2b249440
---
M .phpcs.xml
M includes/ApiQueryExtracts.php
M includes/ExtractFormatter.php
3 files changed, 29 insertions(+), 1 deletion(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/TextExtracts
refs/changes/40/394240/1
diff --git a/.phpcs.xml b/.phpcs.xml
index b15894e..fba8ef0 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -2,7 +2,6 @@
<ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
<exclude
name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment" />
</rule>
<file>.</file>
diff --git a/includes/ApiQueryExtracts.php b/includes/ApiQueryExtracts.php
index bd41ad1..83215a5 100644
--- a/includes/ApiQueryExtracts.php
+++ b/includes/ApiQueryExtracts.php
@@ -59,11 +59,20 @@
*/
private $supportedContentModels = [ 'wikitext' ];
+ /**
+ * @param \ApiQuery $query API query module object
+ * @param string $moduleName Name of this query module
+ * @param Config $conf MediaWiki configuration
+ * @return ApiQueryExtracts
+ */
public function __construct( $query, $moduleName, Config $conf ) {
parent::__construct( $query, $moduleName, 'ex' );
$this->config = $conf;
}
+ /**
+ @return null
+ */
public function execute() {
$titles = $this->getPageSet()->getGoodTitles();
if ( count( $titles ) == 0 ) {
@@ -120,6 +129,10 @@
}
}
+ /**
+ * @param array $params Ignored parameters
+ * @return string
+ */
public function getCacheMode( $params ) {
return 'public';
}
@@ -394,6 +407,10 @@
return "\n$text";
}
+ /**
+ * Return an array describing all possible parameters to this module
+ * @return array
+ */
public function getAllowedParams() {
return [
'chars' => [
@@ -437,6 +454,10 @@
];
}
+ /**
+ * @see ApiBase::getHelpUrls()
+ * @return string
+ */
public function getHelpUrls() {
return
'https://www.mediawiki.org/wiki/Extension:TextExtracts#API';
}
diff --git a/includes/ExtractFormatter.php b/includes/ExtractFormatter.php
index f1d5f0a..7ba01d5 100644
--- a/includes/ExtractFormatter.php
+++ b/includes/ExtractFormatter.php
@@ -49,6 +49,10 @@
}
}
+ /**
+ * @param DOMElement|string|null $dummy Ignored
+ * @return string
+ */
public function getText( $dummy = null ) {
$this->filterContent();
$text = parent::getText();
@@ -61,6 +65,10 @@
return $text;
}
+ /**
+ * @param string $html HTML string to process
+ * @return string Processed HTML
+ */
public function onHtmlReady( $html ) {
if ( $this->plainText ) {
$html = preg_replace( '/\s*(<h([1-6])\b)/i',
--
To view, visit https://gerrit.wikimedia.org/r/394240
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I0a0055f1de57f15a45c21e2f51ed275a2b249440
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/TextExtracts
Gerrit-Branch: master
Gerrit-Owner: Pppery <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
