summaryrefslogtreecommitdiff
path: root/includes/FeedUtils.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/FeedUtils.php')
-rw-r--r--includes/FeedUtils.php52
1 files changed, 30 insertions, 22 deletions
diff --git a/includes/FeedUtils.php b/includes/FeedUtils.php
index 22cb52be..6937c32d 100644
--- a/includes/FeedUtils.php
+++ b/includes/FeedUtils.php
@@ -33,8 +33,8 @@ class FeedUtils {
* If the feed should be purged; $timekey and $key will be removed from
* $messageMemc
*
- * @param string $timekey cache key of the timestamp of the last item
- * @param string $key cache key of feed's content
+ * @param string $timekey Cache key of the timestamp of the last item
+ * @param string $key Cache key of feed's content
*/
public static function checkPurge( $timekey, $key ) {
global $wgRequest, $wgUser, $messageMemc;
@@ -48,8 +48,8 @@ class FeedUtils {
/**
* Check whether feeds can be used and that $type is a valid feed type
*
- * @param string $type feed type, as requested by the user
- * @return Boolean
+ * @param string $type Feed type, as requested by the user
+ * @return bool
*/
public static function checkFeedOutput( $type ) {
global $wgOut, $wgFeed, $wgFeedClasses;
@@ -70,8 +70,8 @@ class FeedUtils {
/**
* Format a diff for the newsfeed
*
- * @param $row Object: row from the recentchanges table
- * @return String
+ * @param object $row Row from the recentchanges table
+ * @return string
*/
public static function formatDiff( $row ) {
$titleObj = Title::makeTitle( $row->rc_namespace, $row->rc_title );
@@ -94,15 +94,17 @@ class FeedUtils {
/**
* Really format a diff for the newsfeed
*
- * @param $title Title object
- * @param $oldid Integer: old revision's id
- * @param $newid Integer: new revision's id
- * @param $timestamp Integer: new revision's timestamp
- * @param string $comment new revision's comment
- * @param string $actiontext text of the action; in case of log event
- * @return String
+ * @param Title $title Title object
+ * @param int $oldid Old revision's id
+ * @param int $newid New revision's id
+ * @param int $timestamp New revision's timestamp
+ * @param string $comment New revision's comment
+ * @param string $actiontext Text of the action; in case of log event
+ * @return string
*/
- public static function formatDiffRow( $title, $oldid, $newid, $timestamp, $comment, $actiontext = '' ) {
+ public static function formatDiffRow( $title, $oldid, $newid, $timestamp,
+ $comment, $actiontext = ''
+ ) {
global $wgFeedDiffCutoff, $wgLang;
wfProfileIn( __METHOD__ );
@@ -214,9 +216,9 @@ class FeedUtils {
* Generates a diff link. Used when the full diff is not wanted for example
* when $wgFeedDiffCutoff is 0.
*
- * @param $title Title object: used to generate the diff URL
- * @param $newid Integer newid for this diff
- * @param $oldid Integer|null oldid for the diff. Null means it is a new article
+ * @param Title $title Title object: used to generate the diff URL
+ * @param int $newid Newid for this diff
+ * @param int|null $oldid Oldid for the diff. Null means it is a new article
* @return string
*/
protected static function getDiffLink( Title $title, $newid, $oldid = null ) {
@@ -237,17 +239,23 @@ class FeedUtils {
* Might be 'cleaner' to use DOM or XSLT or something,
* but *gack* it's a pain in the ass.
*
- * @param string $text diff's HTML output
- * @return String: modified HTML
+ * @param string $text Diff's HTML output
+ * @return string Modified HTML
*/
public static function applyDiffStyle( $text ) {
$styles = array(
'diff' => 'background-color: white; color:black;',
'diff-otitle' => 'background-color: white; color:black; text-align: center;',
'diff-ntitle' => 'background-color: white; color:black; text-align: center;',
- 'diff-addedline' => 'color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;',
- 'diff-deletedline' => 'color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;',
- 'diff-context' => 'background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;',
+ 'diff-addedline' => 'color:black; font-size: 88%; border-style: solid; '
+ . 'border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; '
+ . 'vertical-align: top; white-space: pre-wrap;',
+ 'diff-deletedline' => 'color:black; font-size: 88%; border-style: solid; '
+ . 'border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; '
+ . 'vertical-align: top; white-space: pre-wrap;',
+ 'diff-context' => 'background-color: #f9f9f9; color: #333333; font-size: 88%; '
+ . 'border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; '
+ . 'border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;',
'diffchange' => 'font-weight: bold; text-decoration: none;',
);