jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/349282 )
Change subject: Enforce MW coding convention with phpcs
......................................................................
Enforce MW coding convention with phpcs
Bug: T163487
Change-Id: Ibd2aeddd1e71122f006173c562b446685d7e9127
---
M Newsletter.hooks.php
M composer.json
M includes/NewsletterEditPage.php
M includes/NewsletterStore.php
M includes/content/NewsletterContent.php
M includes/content/NewsletterDataUpdate.php
M includes/logging/NewsletterLogger.php
M includes/specials/SpecialNewsletter.php
M includes/specials/SpecialNewsletterCreate.php
M maintenance/deleteInactiveNewsletters.php
A phpcs.xml
11 files changed, 76 insertions(+), 37 deletions(-)
Approvals:
01tonythomas: Looks good to me, approved
jenkins-bot: Verified
diff --git a/Newsletter.hooks.php b/Newsletter.hooks.php
index 54a64b1..48cb1c0 100755
--- a/Newsletter.hooks.php
+++ b/Newsletter.hooks.php
@@ -109,9 +109,12 @@
$updater->addExtensionTable( 'nl_issues', __DIR__ .
'/sql/nl_issues.sql' );
$updater->addExtensionTable( 'nl_subscriptions', __DIR__ .
'/sql/nl_subscriptions.sql' );
$updater->addExtensionTable( 'nl_publishers', __DIR__ .
'/sql/nl_publishers.sql' );
- $updater->addExtensionField( 'nl_newsletters', 'nl_active',
__DIR__ . '/sql/nl_newsletters-add-active.sql' );
- $updater->dropExtensionIndex( 'nl_newsletters',
'nl_main_page_id', __DIR__ . '/sql/nl_main_page_id-drop-index.sql' );
- $updater->addExtensionIndex( 'nl_newsletters',
'nl_main_page_active', __DIR__ . '/sql/nl_newsletters-add-unique.sql' );
+ $updater->addExtensionField( 'nl_newsletters', 'nl_active',
+ __DIR__ . '/sql/nl_newsletters-add-active.sql' );
+ $updater->dropExtensionIndex( 'nl_newsletters',
'nl_main_page_id',
+ __DIR__ . '/sql/nl_main_page_id-drop-index.sql' );
+ $updater->addExtensionIndex( 'nl_newsletters',
'nl_main_page_active',
+ __DIR__ . '/sql/nl_newsletters-add-unique.sql' );
return true;
}
@@ -210,7 +213,8 @@
* @return bool
* @throws PermissionsError
*/
- public static function onArticleDelete( &$wikiPage, &$user, &$reason,
&$error, Status &$status, $suppress ) {
+ public static function onArticleDelete( &$wikiPage, &$user, &$reason,
&$error, Status &$status,
+ $suppress ) {
if ( !$wikiPage->getTitle()->inNamespace( NS_NEWSLETTER ) ) {
return true;
}
@@ -315,7 +319,8 @@
* @throws ThrottledError
*/
public static function onEditFilterMergedContent( IContextSource
$context, Content $content,
- Status $status,
$summary, User $user, $minoredit ) {
+ Status $status,
$summary, User $user,
+ $minoredit ) {
global $wgUser;
if ( !$context->getTitle()->inNamespace( NS_NEWSLETTER ) ) {
return;
@@ -332,11 +337,11 @@
$newsletter = Newsletter::newFromName(
$context->getTitle()->getText() );
// Validate API Edit parameters
- $formData = array(
+ $formData = [
'Name' => $context->getTitle()->getText(),
'Description' => $content->getDescription(),
'MainPage' => $content->getMainPage(),
- );
+ ];
$validator = new NewsletterValidator( $formData );
$validation = $validator->validate( !$newsletter );
if ( !$validation->isGood() ) {
diff --git a/composer.json b/composer.json
index 320081d..786fd5b 100644
--- a/composer.json
+++ b/composer.json
@@ -1,15 +1,19 @@
{
"type": "mediawiki-extension",
+ "license": "GPL-2.0",
"require": {
"wikimedia/assert": ">=0.1 <0.3"
},
"require-dev": {
"jakub-onderka/php-parallel-lint": "0.9.2",
- "jakub-onderka/php-console-highlighter": "0.3.2"
+ "jakub-onderka/php-console-highlighter": "0.3.2",
+ "mediawiki/mediawiki-codesniffer": "0.7.2"
},
"scripts": {
"test": [
- "parallel-lint . --exclude vendor"
- ]
+ "parallel-lint . --exclude vendor",
+ "phpcs -p -s"
+ ],
+ "fix": "phpcbf"
}
}
diff --git a/includes/NewsletterEditPage.php b/includes/NewsletterEditPage.php
index 7a87c8d..8fee487 100644
--- a/includes/NewsletterEditPage.php
+++ b/includes/NewsletterEditPage.php
@@ -51,7 +51,9 @@
return;
}
- $this->out->setPageTitle( $this->context->msg(
'newslettercreate', $this->title->getPrefixedText() )->text() );
+ $this->out->setPageTitle(
+ $this->context->msg( 'newslettercreate',
$this->title->getPrefixedText() )->text()
+ );
$this->getForm()->show();
}
}
diff --git a/includes/NewsletterStore.php b/includes/NewsletterStore.php
index 913518d..30dbfd9 100644
--- a/includes/NewsletterStore.php
+++ b/includes/NewsletterStore.php
@@ -217,7 +217,8 @@
*
* @return bool
*/
- public function addNewsletterIssue( Newsletter $newsletter, Title
$title, User $publisher, $summary ) {
+ public function addNewsletterIssue( Newsletter $newsletter, Title
$title, User $publisher,
+ $summary ) {
$success = $this->db->addNewsletterIssue( $newsletter, $title,
$publisher );
if ( $success ) {
$this->logger->logNewIssue( $publisher, $newsletter,
$title, $success, $summary );
diff --git a/includes/content/NewsletterContent.php
b/includes/content/NewsletterContent.php
index 4039492..92e8573 100644
--- a/includes/content/NewsletterContent.php
+++ b/includes/content/NewsletterContent.php
@@ -124,10 +124,11 @@
// No-op: We have already redirected.
}
- protected function fillParserOutput( Title $title, $revId,
ParserOptions $options, $generateHtml, ParserOutput &$output ) {
+ protected function fillParserOutput( Title $title, $revId,
ParserOptions $options,
+ $generateHtml, ParserOutput
&$output ) {
if ( $generateHtml ) {
$this->newsletter = Newsletter::newFromName(
$title->getText() );
- //Make sure things are decoded at this point
+ // Make sure things are decoded at this point
$this->decode();
$newsletterActionButtons = !$this->newsletter ? '' :
$this->getNewsletterActionButtons(
@@ -179,14 +180,16 @@
$logs = '';
$logCount = LogEventsList::showLogExtract(
$logs, // by reference
'newsletter',
- SpecialPage::getTitleFor( 'Newsletter',
$this->newsletter->getId() ), '', array(
+ SpecialPage::getTitleFor( 'Newsletter',
$this->newsletter->getId() ), '',
+ [
'lim' => 10,
'showIfEmpty' => false,
- 'conds' => array( 'log_action'
=> 'issue-added' ),
- 'extraUrlParams' => array(
'subtype' => 'issue-added' ),
- ) );
+ 'conds' => [ 'log_action' =>
'issue-added' ],
+ 'extraUrlParams' => [ 'subtype'
=> 'issue-added' ],
+ ]
+ );
if ( $logCount !== 0 ) {
- $fields['issues'] = array(
+ $fields['issues'] = [
'type' => 'info',
'raw' => true,
'default' => $logs,
@@ -194,7 +197,7 @@
->inLanguage(
$options->getUserLangObj() )
->numParams( $logCount )
->text(),
- );
+ ];
}
}
$form = $this->getHTMLForm(
@@ -370,7 +373,8 @@
}
$links = [];
foreach ( $actions as $action ) {
- $title = SpecialPage::getTitleFor( 'Newsletter',
$this->newsletter->getId() . '/' . $action );
+ $title = SpecialPage::getTitleFor( 'Newsletter',
$this->newsletter->getId() . '/' .
+
$action );
// Messages used here:
'newsletter-subtitlelinks-announce',
// 'newsletter-subtitlelinks-subscribe',
'newsletter-subtitlelinks-unsubscribe'
@@ -385,10 +389,15 @@
$links[] = $link;
}
$newsletterLinks = Linker::makeSelfLinkObj(
- SpecialPage::getTitleFor( 'Newsletter',
$this->newsletter->getId() ), $this->getEscapedName()
- ) . ' ' . wfMessage( 'parentheses' )->rawParams(
$options->getUserLangObj()->pipeList( $links ) )->escaped();
+ SpecialPage::getTitleFor( 'Newsletter',
$this->newsletter->getId() ),
+ $this->getEscapedName()
+ ) . ' ' . wfMessage( 'parentheses' )->rawParams(
+ $options->getUserLangObj()->pipeList( $links )
+ )->escaped();
- return $wgOut->setSubtitle(
$options->getUserLangObj()->pipeList( [ $listLink, $newsletterLinks ] ) );
+ return $wgOut->setSubtitle(
+ $options->getUserLangObj()->pipeList( [ $listLink,
$newsletterLinks ] )
+ );
}
/**
@@ -445,7 +454,8 @@
* @param Content $old Content object representing the page's content
before the edit.
* @param bool $recursive bool indicating whether DataUpdates should
trigger recursive
* updates (relevant mostly for LinksUpdate).
- * @param ParserOutput $parserOutput ParserOutput representing the
rendered version of the page after the edit.
+ * @param ParserOutput $parserOutput ParserOutput representing the
rendered version of
+ * the page after the edit.
* @return DataUpdate[]
*
* @see Content::getSecondaryDataUpdates()
diff --git a/includes/content/NewsletterDataUpdate.php
b/includes/content/NewsletterDataUpdate.php
index 5dfb0de..f42f985 100644
--- a/includes/content/NewsletterDataUpdate.php
+++ b/includes/content/NewsletterDataUpdate.php
@@ -42,7 +42,7 @@
$rows = $dbr->select(
'nl_newsletters',
[ 'nl_name', 'nl_main_page_id', 'nl_active' ],
- $dbr->makeList([
+ $dbr->makeList( [
'nl_name' => $this->name,
$dbr->makeList(
[
@@ -89,16 +89,17 @@
$updatedMainPageId =
$this->content->getMainPage()->getArticleID();
if ( $updatedMainPageId != $newsletter->getPageId() ) {
- $store->updateMainPage($newsletterId,
$updatedMainPageId );
+ $store->updateMainPage( $newsletterId,
$updatedMainPageId );
}
$updatedPublishers = array_map( 'User::newFromName',
$this->content->getPublishers() );
$oldPublishersIds = $newsletter->getPublishers();
- $updatedPublishersIds = array();
+ $updatedPublishersIds = [];
foreach ( $updatedPublishers as $user ) {
- if ( $user instanceof User )
+ if ( $user instanceof User ) {
$updatedPublishersIds[] = $user->getId();
+ }
}
// Do the actual modifications now
@@ -112,15 +113,15 @@
if ( $added ) {
EchoEvent::create(
- array(
+ [
'type' => 'newsletter-newpublisher',
- 'extra' => array(
+ 'extra' => [
'newsletter-name' =>
$newsletter->getName(),
'new-publishers-id' => $added,
'newsletter-id' => $newsletterId
- ),
+ ],
'agent' => $this->user
- )
+ ]
);
}
foreach ( $removed as $ruId ) {
diff --git a/includes/logging/NewsletterLogger.php
b/includes/logging/NewsletterLogger.php
index 14c266e..6fd19d1 100644
--- a/includes/logging/NewsletterLogger.php
+++ b/includes/logging/NewsletterLogger.php
@@ -41,7 +41,8 @@
$log->publish( $log->insert() );
}
- public function logNewIssue( User $publisher, Newsletter $newsletter,
Title $issueTitle, $issueId, $comment ) {
+ public function logNewIssue( User $publisher, Newsletter $newsletter,
Title $issueTitle,
+ $issueId, $comment ) {
$log = new ManualLogEntry( 'newsletter', 'issue-added' );
$log->setPerformer( $publisher );
$log->setTarget( SpecialPage::getTitleFor( 'Newsletter',
$newsletter->getId() ) );
diff --git a/includes/specials/SpecialNewsletter.php
b/includes/specials/SpecialNewsletter.php
index 1225aa5..a2e0dc2 100644
--- a/includes/specials/SpecialNewsletter.php
+++ b/includes/specials/SpecialNewsletter.php
@@ -228,7 +228,9 @@
$form->addHeaderText( $txt );
$form->suppressDefaultSubmit();
$form->show();
- $this->getOutput()->addReturnTo( Title::makeTitleSafe(
NS_NEWSLETTER, $this->newsletter->getName() ) );
+ $this->getOutput()->addReturnTo( Title::makeTitleSafe(
+ NS_NEWSLETTER, $this->newsletter->getName() )
+ );
}
/**
diff --git a/includes/specials/SpecialNewsletterCreate.php
b/includes/specials/SpecialNewsletterCreate.php
index 6e8a201..0651a03 100644
--- a/includes/specials/SpecialNewsletterCreate.php
+++ b/includes/specials/SpecialNewsletterCreate.php
@@ -89,7 +89,7 @@
$rows = $dbr->select(
'nl_newsletters',
[ 'nl_name', 'nl_main_page_id', 'nl_active' ],
- $dbr->makeList([
+ $dbr->makeList( [
'nl_name' => $data['Name'],
$dbr->makeList(
[
diff --git a/maintenance/deleteInactiveNewsletters.php
b/maintenance/deleteInactiveNewsletters.php
index 9abaa3f..0902ae7 100644
--- a/maintenance/deleteInactiveNewsletters.php
+++ b/maintenance/deleteInactiveNewsletters.php
@@ -1,6 +1,7 @@
<?php
-$basePath = getenv( 'MW_INSTALL_PATH' ) !== false ? getenv( 'MW_INSTALL_PATH'
) : __DIR__ . '/../../..';
+$basePath = getenv( 'MW_INSTALL_PATH' ) !== false ?
+ getenv( 'MW_INSTALL_PATH' ) : __DIR__ . '/../../..';
require_once $basePath . '/maintenance/Maintenance.php';
diff --git a/phpcs.xml b/phpcs.xml
new file mode 100644
index 0000000..63c9297
--- /dev/null
+++ b/phpcs.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<ruleset>
+ <rule ref="vendor/mediawiki/mediawiki-codesniffer/MediaWiki"/>
+ <rule ref="Generic.Files.LineLength.TooLong">
+ <exclude-pattern>*/tests/*</exclude-pattern>
+ </rule>
+ <file>.</file>
+ <arg name="extensions" value="php,php5,inc"/>
+ <arg name="encoding" value="utf8"/>
+ <exclude-pattern>node_modules</exclude-pattern>
+ <exclude-pattern>vendor</exclude-pattern>
+</ruleset>
--
To view, visit https://gerrit.wikimedia.org/r/349282
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ibd2aeddd1e71122f006173c562b446685d7e9127
Gerrit-PatchSet: 3
Gerrit-Project: mediawiki/extensions/Newsletter
Gerrit-Branch: master
Gerrit-Owner: Brian Wolff <bawolff...@gmail.com>
Gerrit-Reviewer: 01tonythomas <01tonytho...@gmail.com>
Gerrit-Reviewer: Addshore <addshorew...@gmail.com>
Gerrit-Reviewer: Legoktm <lego...@member.fsf.org>
Gerrit-Reviewer: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
