src/applications/releeph/field/specification/ReleephFieldSpecification.php

   1 <?php
   2
   3 abstract class ReleephFieldSpecification
   4   extends PhabricatorCustomField
   5   implements PhabricatorMarkupInterface {
   6
   7   // TODO: This is temporary, until ReleephFieldSpecification is more conformant
   8   // to PhabricatorCustomField.
   9   private $requestValue;
  10
  11   public function readValueFromRequest(AphrontRequest $request) {
  12     $this->requestValue = $request->getStr($this->getRequiredStorageKey());
  13     return $this;
  14   }
  15
  16   public function shouldAppearInPropertyView() {
  17     return true;
  18   }
  19
  20   public function renderPropertyViewLabel() {
  21     return $this->getName();
  22   }
  23
  24   public function renderPropertyViewValue(array $handles) {
  25     $key = $this->getRequiredStorageKey();
  26     $value = $this->getReleephRequest()->getDetail($key);
  27     if ($value === '') {
  28       return null;
  29     }
  30     return $value;
  31   }
  32
  33   abstract public function getName();
  34
  35 /* -(  Storage  )------------------------------------------------------------ */
  36
  37   public function getStorageKey() {
  38     return null;
  39   }
  40
  41   public function getRequiredStorageKey() {
  42     $key = $this->getStorageKey();
  43     if ($key === null) {
  44       throw new PhabricatorCustomFieldImplementationIncompleteException($this);
  45     }
  46     if (strpos($key, '.') !== false) {
  47       /**
  48        * Storage keys are reused for form controls, and periods in form control
  49        * names break HTML forms.
  50        */
  51       throw new Exception(pht("You can't use '%s' in storage keys!", '.'));
  52     }
  53     return $key;
  54   }
  55
  56   public function shouldAppearInEditView() {
  57     return $this->isEditable();
  58   }
  59
  60   final public function isEditable() {
  61     return $this->getStorageKey() !== null;
  62   }
  63
  64   final public function getValue() {
  65     if ($this->requestValue !== null) {
  66       return $this->requestValue;
  67     }
  68
  69     $key = $this->getRequiredStorageKey();
  70     return $this->getReleephRequest()->getDetail($key);
  71   }
  72
  73   final public function setValue($value) {
  74     $key = $this->getRequiredStorageKey();
  75     return $this->getReleephRequest()->setDetail($key, $value);
  76   }
  77
  78   /**
  79    * @throws ReleephFieldParseException, to show an error.
  80    */
  81   public function validate($value) {
  82     return;
  83   }
  84
  85   /**
  86    * Turn values as they are stored in a ReleephRequest into a text that can be
  87    * rendered as a transactions old/new values.
  88    */
  89   public function normalizeForTransactionView(
  90     PhabricatorApplicationTransaction $xaction,
  91     $value) {
  92
  93     return $value;
  94   }
  95
  96
  97 /* -(  Conduit  )------------------------------------------------------------ */
  98
  99   public function getKeyForConduit() {
 100     return $this->getRequiredStorageKey();
 101   }
 102
 103   public function getValueForConduit() {
 104     return $this->getValue();
 105   }
 106
 107   public function setValueFromConduitAPIRequest(ConduitAPIRequest $request) {
 108     $value = idx(
 109       $request->getValue('fields', array()),
 110       $this->getRequiredStorageKey());
 111     $this->validate($value);
 112     $this->setValue($value);
 113     return $this;
 114   }
 115
 116
 117 /* -(  Arcanist  )----------------------------------------------------------- */
 118
 119   public function renderHelpForArcanist() {
 120     return '';
 121   }
 122
 123
 124 /* -(  Context  )------------------------------------------------------------ */
 125
 126   private $releephProject;
 127   private $releephBranch;
 128   private $releephRequest;
 129   private $user;
 130
 131   final public function setReleephProject(ReleephProject $rp) {
 132     $this->releephProject = $rp;
 133     return $this;
 134   }
 135
 136   final public function setReleephBranch(ReleephBranch $rb) {
 137     $this->releephRequest = $rb;
 138     return $this;
 139   }
 140
 141   final public function setReleephRequest(ReleephRequest $rr) {
 142     $this->releephRequest = $rr;
 143     return $this;
 144   }
 145
 146   final public function setUser(PhabricatorUser $user) {
 147     $this->user = $user;
 148     return $this;
 149   }
 150
 151   final public function getReleephProject() {
 152     if (!$this->releephProject) {
 153       return $this->getReleephBranch()->getProduct();
 154     }
 155     return $this->releephProject;
 156   }
 157
 158   final public function getReleephBranch() {
 159     if (!$this->releephBranch) {
 160       return $this->getReleephRequest()->getBranch();
 161     }
 162     return $this->releephBranch;
 163   }
 164
 165   final public function getReleephRequest() {
 166     if (!$this->releephRequest) {
 167       return $this->getObject();
 168     }
 169     return $this->releephRequest;
 170   }
 171
 172   final public function getUser() {
 173     if (!$this->user) {
 174       return $this->getViewer();
 175     }
 176     return $this->user;
 177   }
 178
 179 /* -(  Commit Messages  )---------------------------------------------------- */
 180
 181   public function shouldAppearOnCommitMessage() {
 182     return false;
 183   }
 184
 185   public function renderLabelForCommitMessage() {
 186     throw new PhabricatorCustomFieldImplementationIncompleteException($this);
 187   }
 188
 189   public function renderValueForCommitMessage() {
 190     throw new PhabricatorCustomFieldImplementationIncompleteException($this);
 191   }
 192
 193   public function shouldAppearOnRevertMessage() {
 194     return false;
 195   }
 196
 197   public function renderLabelForRevertMessage() {
 198     return $this->renderLabelForCommitMessage();
 199   }
 200
 201   public function renderValueForRevertMessage() {
 202     return $this->renderValueForCommitMessage();
 203   }
 204
 205
 206 /* -(  Markup Interface  )--------------------------------------------------- */
 207
 208   const MARKUP_FIELD_GENERIC = 'releeph:generic-markup-field';
 209
 210   private $engine;
 211
 212   /**
 213    * @{class:ReleephFieldSpecification} implements much of
 214    * @{interface:PhabricatorMarkupInterface} for you. If you return true from
 215    * `shouldMarkup()`, and implement `getMarkupText()` then your text will be
 216    * rendered through the Phabricator markup pipeline.
 217    *
 218    * Output is retrievable with `getMarkupEngineOutput()`.
 219    */
 220   public function shouldMarkup() {
 221     return false;
 222   }
 223
 224   public function getMarkupText($field) {
 225     throw new PhabricatorCustomFieldImplementationIncompleteException($this);
 226   }
 227
 228   final public function getMarkupEngineOutput() {
 229     return $this->engine->getOutput($this, self::MARKUP_FIELD_GENERIC);
 230   }
 231
 232   final public function setMarkupEngine(PhabricatorMarkupEngine $engine) {
 233     $this->engine = $engine;
 234     $engine->addObject($this, self::MARKUP_FIELD_GENERIC);
 235     return $this;
 236   }
 237
 238   final public function getMarkupFieldKey($field) {
 239     $content = sprintf(
 240       '%s:%s:%s:%s',
 241       $this->getReleephRequest()->getPHID(),
 242       $this->getStorageKey(),
 243       $field,
 244       $this->getMarkupText($field));
 245
 246     return PhabricatorMarkupEngine::digestRemarkupContent($this, $content);
 247   }
 248
 249   final public function newMarkupEngine($field) {
 250     return PhabricatorMarkupEngine::newDifferentialMarkupEngine();
 251   }
 252
 253   final public function didMarkupText(
 254     $field,
 255     $output,
 256     PhutilMarkupEngine $engine) {
 257
 258     return $output;
 259   }
 260
 261   final public function shouldUseMarkupCache($field) {
 262     return true;
 263   }
 264
 265 }