Homec4science
Diffusion Phabricator (feature/testing) Browse

phab/src/applications/feed/conduit/FeedQueryConduitAPIMethod.php
d1842929afaafeature/testing

Last Change
Raw File

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';
}
$limit = $request->getValue('limit');
if (!$limit) {
$limit = $this->getDefaultLimit();
}
$query = id(new PhabricatorFeedQuery())
->setLimit($limit)
->setViewer($user);
$filter_phids = $request->getValue('filterPHIDs');
if ($filter_phids) {
$query->withFilterPHIDs($filter_phids);
}
$after = $request->getValue('after');
if (strlen($after)) {
$query->setAfterID($after);
}
$before = $request->getValue('before');
if (strlen($before)) {
$query->setBeforeID($before);
}
$stories = $query->execute();
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;
}
}
c4science · Help