EBernhardson has uploaded a new change for review.
https://gerrit.wikimedia.org/r/187145
Change subject: Introduce ApiFeedContributions::feedItem hook
......................................................................
Introduce ApiFeedContributions::feedItem hook
ContribsPager, which is used by ApiFeedContributions, can return more
than just revision rows. This is handled in the html side within the
ContributionsLineEnding hook. ApiFeedContributions had no special
handling so here I have added a simple hook the provides the data
from ContribsPager and allows subscribers to provide the appropriate
FeedItem instance.
Bug: T85229
Change-Id: I27c77cc682ba801c40361c76b67398108ca1a592
(cherry picked from commit dbc3c5306ec74a0f21e17d3f1421458f1e5c6731)
---
M docs/hooks.txt
M includes/api/ApiFeedContributions.php
2 files changed, 32 insertions(+), 1 deletion(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core
refs/changes/45/187145/1
diff --git a/docs/hooks.txt b/docs/hooks.txt
index 2de78dd..4717c38 100644
--- a/docs/hooks.txt
+++ b/docs/hooks.txt
@@ -372,6 +372,17 @@
$text : the new text of the article (has yet to be saved)
&$resultArr : data in this array will be added to the API result
+'ApiFeedContributions::feedItem': Called to convert the result of ContribsPager
+into a FeedItem instance that ApiFeedContributions can consume. Implementors of
+this hook may cancel the hook to signal that the item is not viewable in the
+provided context.
+$row: A row of data from ContribsPager. The set of data returned by
ContribsPager
+ can be adjusted by handling the ContribsPager::reallyDoQuery hook.
+$context: An IContextSource implementation.
+&$feedItem: Set this to a FeedItem instance if the callback can handle the
provided
+ row. This is provided to the hook as a null, if it is non null then another
callback
+ has already handled the hook.
+
'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
highlighting, add output to $context->getOutput() and return false.
$context: An IContextSource.
diff --git a/includes/api/ApiFeedContributions.php
b/includes/api/ApiFeedContributions.php
index ced5f0c..edda672 100644
--- a/includes/api/ApiFeedContributions.php
+++ b/includes/api/ApiFeedContributions.php
@@ -95,7 +95,10 @@
if ( ++$count > $limit ) {
break;
}
- $feedItems[] = $this->feedItem( $row );
+ $item = $this->feedItem( $row );
+ if ( $item !== null ) {
+ $feedItems[] = $item;
+ }
}
}
@@ -103,6 +106,23 @@
}
protected function feedItem( $row ) {
+ // This hook is the api contributions equivalent to the
+ // ContributionsLineEnding hook. Hook implementers may cancel
+ // the hook to signal the user is not allowed to read this item.
+ $feedItem = null;
+ $hookResult = Hooks::run(
+ 'ApiFeedContributions::feedItem',
+ array( $row, $this->getContext(), &$feedItem )
+ );
+ // Hook returned a valid feed item
+ if ( $feedItem instanceof FeedItem ) {
+ return $feedItem;
+ // Hook was canceled and did not return a valid feed item
+ } elseif ( !$hookResult ) {
+ return null;
+ }
+
+ // Hook completed and did not return a valid feed item
$title = Title::makeTitle( intval( $row->page_namespace ),
$row->page_title );
if ( $title && $title->userCan( 'read', $this->getUser() ) ) {
$date = $row->rev_timestamp;
--
To view, visit https://gerrit.wikimedia.org/r/187145
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I27c77cc682ba801c40361c76b67398108ca1a592
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: wmf/1.25wmf14
Gerrit-Owner: EBernhardson <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
