jenkins-bot has submitted this change and it was merged.
Change subject: Minor code cleanups
......................................................................
Minor code cleanups
* doc fixes
* redundant var decl
* consolidated some code into addWarning to reduce code size
Change-Id: I944b8527c68603f2c688f63964c18808642627f5
---
M includes/PageRenderingHooks.php
1 file changed, 41 insertions(+), 35 deletions(-)
Approvals:
Dr0ptp4kt: Verified; Looks good to me, approved
jenkins-bot: Verified
diff --git a/includes/PageRenderingHooks.php b/includes/PageRenderingHooks.php
index d31af8f..1e68499 100644
--- a/includes/PageRenderingHooks.php
+++ b/includes/PageRenderingHooks.php
@@ -1,6 +1,7 @@
<?php
namespace Extensions\ZeroRatedMobileAccess;
+use BaseTemplate;
use DOMDocument;
use DOMElement;
use DOMXPath;
@@ -12,6 +13,7 @@
use ResourceLoader;
use Title;
use SkinTemplate;
+use WebRequest;
/**
* Main class for ZeroRatedMobileAccess extension.
@@ -49,7 +51,11 @@
return true;
}
- public static function onMinervaPreRender( \BaseTemplate $template ) {
+ /**
+ * @param BaseTemplate $template
+ * @return bool
+ */
+ public static function onMinervaPreRender( BaseTemplate $template ) {
$req = $template->getSkin()->getRequest();
$out = $template->getSkin()->getOutput();
@@ -85,25 +91,24 @@
}
$skin = new SkinTemplate();
- $redirectWarning = '&renderZeroRatedRedirect=true&returnto=';
- $pattern = '/href=[\'"](.*?)[\'"]/';
- $licenseText = wfMessage( 'mobile-frontend-footer-license'
)->parse();
- $privacyText = $skin->footerLink(
'mobile-frontend-privacy-link-text', 'privacypage' );
- $termsText = wfMessage( 'mobile-frontend-terms-use-text'
)->parse();
-
- $licenseText = self::addWarning( $req, $pattern, $licenseText,
$redirectWarning );
- $privacyText = self::addWarning( $req, $pattern, $privacyText,
$redirectWarning );
- $termsText = self::addWarning( $req, $pattern, $termsText,
$redirectWarning );
-
- $template->set( 'mobile-license', $licenseText );
- $template->set( 'privacy', $privacyText );
- $template->set( 'terms-use', $termsText );
+ self::addWarning( $template, 'mobile-license', $req, wfMessage(
'mobile-frontend-footer-license' )->parse() );
+ self::addWarning( $template, 'privacy', $req,
$skin->footerLink( 'mobile-frontend-privacy-link-text', 'privacypage' ) );
+ self::addWarning( $template, 'terms-use', $req, wfMessage(
'mobile-frontend-terms-use-text' )->parse() );
return true;
}
- public static function onGetMobileNotice( SkinTemplate $sk, &$notice ) {
+ /**
+ * @param SkinTemplate $sk
+ * @param $notice
+ * @return bool
+ */
+ public static function onGetMobileNotice(
+ /** @noinspection PhpUnusedParameterInspection */
+ SkinTemplate $sk,
+ &$notice
+ ) {
global $wgRequest;
global $wgOut;
@@ -237,11 +242,12 @@
/**
* Render the "red" banner for the unknown IP when accessing zero.*
- * @param \WebRequest $req
+ * @param WebRequest $req
* @param OutputPage $out
+ * @param bool $wap
* @return string
*/
- private static function renderUnknownCarrier( \WebRequest $req,
OutputPage $out, $wap = false ) {
+ private static function renderUnknownCarrier( WebRequest $req,
OutputPage $out, $wap = false ) {
$title = $out->getTitle();
$url = $title->getCanonicalURL();
$link = Html::element( 'a',
@@ -277,6 +283,7 @@
* @param $config
* @param Language $lang
* @param string $sitename
+ * @param bool $wap
* @return string
*/
public static function renderBanner( $config, $lang = null, $sitename =
null, $wap = false ) {
@@ -305,8 +312,6 @@
} else {
$carrierLink = '';
}
-
- $banner = '';
if ( $wap ) {
$banner = $carrierLink !== '' ? Html::rawElement( 'p',
null, $carrierLink ) : '';
@@ -344,11 +349,12 @@
* Provide an interstitial warning for links that may cause charges.
*
* @param $config
- * @param $request \WebRequest
- * @param $out OutputPage
+ * @param $request
+ * @param $out
+ * @param bool $wap
* @return null|string Warning banner if applicable, else null
*/
- private static function renderWarning( $config, $request, $out, $wap =
false ) {
+ private static function renderWarning( $config, WebRequest $request,
OutputPage $out, $wap = false ) {
$isFilePage = $out->getTitle()->inNamespace( NS_FILE );
$acceptBilling = $request->getVal( 'acceptbilling' );
@@ -391,6 +397,7 @@
/**
* @param string $acceptUrl If user agrees, send them here
* @param bool $isWarning Adds mw-mf-banner-warning CSS class if true
+ * @param bool $wap
* @return string
*/
private static function renderQuestion( $acceptUrl, $isWarning = false,
$wap = false ) {
@@ -428,13 +435,13 @@
/**
* If a particular language could cause a charge, send user to an
interstitial.
*
- * @param $template \BaseTemplate
+ * @param BaseTemplate $template
* @param $config array containing carrier's configuration
* @param $qps string Query path separator
- * @param $request \WebRequest
+ * @param WebRequest $request
* @return bool
*/
- private static function rewriteLangLinks( $template, $config, $qps,
$request ) {
+ private static function rewriteLangLinks( BaseTemplate $template,
$config, $qps, WebRequest $request ) {
if ( isset( $template->data['language_urls'] )
&& 0 < count( $template->data['language_urls'] )
@@ -462,7 +469,7 @@
/**
* Empty out the Read in Another Language list
*
- * @param \BaseTemplate $template
+ * @param BaseTemplate $template
* @return bool
*/
private static function emptyLangLinks( $template ) {
@@ -862,22 +869,21 @@
}
/**
- * Adds parameters to URLs. Helper for onMinervaPreRender(
\BaseTemplate &$template )
- * @param \WebRequest $request The request object that will contain the
request path.
- * @param string $pattern The regular expression string capturing the
URI.
+ * Adds parameters to URLs. Helper for onMinervaPreRender( BaseTemplate
&$template )
+ * @param BaseTemplate $template
+ * @param $templateValName The name of the template
+ * @param WebRequest $request The request object that will contain the
request path.
* @param string $link The full link, usually parsed wikitext.
- * @param string $redirectQuery The name-value query param string to
add to the URI.
- * @return mixed The link with URIs rewritten.
*/
- private static function addWarning( \WebRequest $request, $pattern,
$link, $redirectQuery ) {
- if ( preg_match( $pattern, $link, $match ) ) {
+ private static function addWarning( BaseTemplate $template,
$templateValName, WebRequest $request, $link ) {
+ if ( preg_match( '/href=[\'"](.*?)[\'"]/', $link, $match ) ) {
$link = str_replace(
$match[1],
- $request->appendQuery( $redirectQuery ) .
urlencode( $match[1] ),
+ $request->appendQuery(
'&renderZeroRatedRedirect=true&returnto=' ) . urlencode( $match[1] ),
$link
);
}
- return $link;
+ $template->set( $templateValName, $link );
}
/**
--
To view, visit https://gerrit.wikimedia.org/r/71136
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I944b8527c68603f2c688f63964c18808642627f5
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/extensions/ZeroRatedMobileAccess
Gerrit-Branch: master
Gerrit-Owner: Yurik <[email protected]>
Gerrit-Reviewer: Dr0ptp4kt <[email protected]>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
