FeedQueryConduitAPIMethod.php
View Options

	<?php

	final class FeedQueryConduitAPIMethod extends FeedConduitAPIMethod {

	public function getAPIMethodName() {
	return 'feed.query';
	}

	public function getMethodStatus() {
	return self::METHOD_STATUS_UNSTABLE;
	}

	public function getMethodDescription() {
	return pht('Query the feed for stories');
	}

	private function getDefaultLimit() {
	return 100;
	}

	protected function defineParamTypes() {
	return array(
	'filterPHIDs' => 'optional list <phid>',
	'limit' => 'optional int (default '.$this->getDefaultLimit().')',
	'after' => 'optional int',
	'before' => 'optional int',
	'view' => 'optional string (data, html, html-summary, text)',
	);
	}

	private function getSupportedViewTypes() {
	return array(
	'html' => pht('Full HTML presentation of story'),
	'data' => pht('Dictionary with various data of the story'),
	'html-summary' => pht('Story contains only the title of the story'),
	'text' => pht('Simple one-line plain text representation of story'),
	);
	}

	protected function defineErrorTypes() {

	$view_types = array_keys($this->getSupportedViewTypes());
	$view_types = implode(', ', $view_types);

	return array(
	'ERR-UNKNOWN-TYPE' =>
	pht(
	'Unsupported view type, possibles are: %s',
	$view_types),
	);
	}

	protected function defineReturnType() {
	return 'nonempty dict';
	}

	protected function execute(ConduitAPIRequest $request) {
	$results = array();
	$user = $request->getUser();

	$view_type = $request->getValue('view');
	if (!$view_type) {
	$view_type = 'data';
	}

	$query = id(new PhabricatorFeedQuery())
	->setViewer($user);

	$filter_phids = $request->getValue('filterPHIDs');
	if ($filter_phids) {
	$query->withFilterPHIDs($filter_phids);
	}

	$limit = $request->getValue('limit');
	if (!$limit) {
	$limit = $this->getDefaultLimit();
	}

	$pager = id(new AphrontCursorPagerView())
	->setPageSize($limit);

	$after = $request->getValue('after');
	if (strlen($after)) {
	$pager->setAfterID($after);
	}

	$before = $request->getValue('before');
	if (strlen($before)) {
	$pager->setBeforeID($before);
	}

	$stories = $query->executeWithCursorPager($pager);

	if ($stories) {
	foreach ($stories as $story) {

	$story_data = $story->getStoryData();

	$data = null;

	try {
	$view = $story->renderView();
	} catch (Exception $ex) {
	// When stories fail to render, just fail that story.
	phlog($ex);
	continue;
	}

	$view->setEpoch($story->getEpoch());
	$view->setUser($user);

	switch ($view_type) {
	case 'html':
	$data = $view->render();
	break;
	case 'html-summary':
	$data = $view->render();
	break;
	case 'data':
	$data = array(
	'class' => $story_data->getStoryType(),
	'epoch' => $story_data->getEpoch(),
	'authorPHID' => $story_data->getAuthorPHID(),
	'chronologicalKey' => $story_data->getChronologicalKey(),
	'data' => $story_data->getStoryData(),
	);
	break;
	case 'text':
	$data = array(
	'class' => $story_data->getStoryType(),
	'epoch' => $story_data->getEpoch(),
	'authorPHID' => $story_data->getAuthorPHID(),
	'chronologicalKey' => $story_data->getChronologicalKey(),
	'objectPHID' => $story->getPrimaryObjectPHID(),
	'text' => $story->renderText(),
	);
	break;
	default:
	throw new ConduitException('ERR-UNKNOWN-TYPE');
	}

	$results[$story_data->getPHID()] = $data;
	}
	}

	return $results;
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Thu, Feb 20, 20:49 (1 d, 16 h ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1144229
Default Alt Text: FeedQueryConduitAPIMethod.php (3 KB)

FeedQueryConduitAPIMethod.php
No OneTemporary
Actions

FeedQueryConduitAPIMethod.php
View Options

File Metadata

Event Timeline

FeedQueryConduitAPIMethod.phpNo OneTemporaryActions

FeedQueryConduitAPIMethod.phpView Options

File Metadata

Event Timeline

FeedQueryConduitAPIMethod.php
No OneTemporary
Actions

FeedQueryConduitAPIMethod.php
View Options