src/applications/maniphest/conduit/ManiphestGetTaskTransactionsConduitAPIMethod.php

   1 <?php
   2
   3 final class ManiphestGetTaskTransactionsConduitAPIMethod
   4   extends ManiphestConduitAPIMethod {
   5
   6   public function getAPIMethodName() {
   7     return 'maniphest.gettasktransactions';
   8   }
   9
  10   public function getMethodDescription() {
  11     return pht('Retrieve Maniphest task transactions.');
  12   }
  13
  14   protected function defineParamTypes() {
  15     return array(
  16       'ids' => 'required list<int>',
  17     );
  18   }
  19
  20   protected function defineReturnType() {
  21     return 'nonempty list<dict<string, wild>>';
  22   }
  23
  24   public function getMethodStatus() {
  25     return self::METHOD_STATUS_FROZEN;
  26   }
  27
  28   public function getMethodStatusDescription() {
  29     return pht(
  30       'This method is frozen and will eventually be deprecated. New code '.
  31       'should use "transaction.search" instead.');
  32   }
  33
  34   protected function execute(ConduitAPIRequest $request) {
  35     $results = array();
  36     $task_ids = $request->getValue('ids');
  37
  38     if (!$task_ids) {
  39       return $results;
  40     }
  41
  42     $tasks = id(new ManiphestTaskQuery())
  43       ->setViewer($request->getUser())
  44       ->withIDs($task_ids)
  45       ->execute();
  46     $tasks = mpull($tasks, null, 'getPHID');
  47
  48     $transactions = array();
  49     if ($tasks) {
  50       $transactions = id(new ManiphestTransactionQuery())
  51         ->setViewer($request->getUser())
  52         ->withObjectPHIDs(mpull($tasks, 'getPHID'))
  53         ->needComments(true)
  54         ->execute();
  55     }
  56
  57     foreach ($transactions as $transaction) {
  58       $task_phid = $transaction->getObjectPHID();
  59       if (empty($tasks[$task_phid])) {
  60         continue;
  61       }
  62
  63       $task_id = $tasks[$task_phid]->getID();
  64
  65       $comments = null;
  66       if ($transaction->hasComment()) {
  67         $comments = $transaction->getComment()->getContent();
  68       }
  69
  70       $results[$task_id][] = array(
  71         'taskID'  => $task_id,
  72         'transactionID' => $transaction->getID(),
  73         'transactionPHID' => $transaction->getPHID(),
  74         'transactionType'  => $transaction->getTransactionType(),
  75         'oldValue'  => $transaction->getOldValue(),
  76         'newValue'  => $transaction->getNewValue(),
  77         'comments'      => $comments,
  78         'authorPHID'  => $transaction->getAuthorPHID(),
  79         'dateCreated' => $transaction->getDateCreated(),
  80       );
  81     }
  82
  83     return $results;
  84   }
  85
  86 }