[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Allow infrastructure to apply transactions to the implementing object.
   5   *
   6   * For example, implementing this interface allows Subscriptions to apply CC
   7   * transactions, and allows Harbormaster to apply build result notifications.
   8   */
   9  interface PhabricatorApplicationTransactionInterface {
  10  
  11    /**
  12     * Return a @{class:PhabricatorApplicationTransactionEditor} which can be
  13     * used to apply transactions to this object.
  14     *
  15     * @return PhabricatorApplicationTransactionEditor Editor for this object.
  16     */
  17    public function getApplicationTransactionEditor();
  18  
  19  
  20    /**
  21     * Return the object to apply transactions to. Normally this is the current
  22     * object (that is, `$this`), but in some cases transactions may apply to
  23     * a different object: for example, @{class:DifferentialDiff} applies
  24     * transactions to the associated @{class:DifferentialRevision}.
  25     *
  26     * @return PhabricatorLiskDAO Object to apply transactions to.
  27     */
  28    public function getApplicationTransactionObject();
  29  
  30  
  31    /**
  32     * Return a template transaction for this object.
  33     *
  34     * @return PhabricatorApplicationTransaction
  35     */
  36    public function getApplicationTransactionTemplate();
  37  
  38  }
  39  
  40  // TEMPLATE IMPLEMENTATION /////////////////////////////////////////////////////
  41  
  42  
  43  /* -(  PhabricatorApplicationTransactionInterface  )------------------------- */
  44  /*
  45  
  46    public function getApplicationTransactionEditor() {
  47      return new <<<???>>>Editor();
  48    }
  49  
  50    public function getApplicationTransactionObject() {
  51      return $this;
  52    }
  53  
  54    public function getApplicationTransactionTemplate() {
  55      return new <<<???>>>Transaction();
  56    }
  57  
  58  */