PhabricatorStandardCustomFieldTokenizer.php

<?php

abstract class PhabricatorStandardCustomFieldTokenizer
  extends PhabricatorStandardCustomFieldPHIDs {

  abstract public function getDatasource();

  public function renderEditControl(array $handles) {
    $value = $this->getFieldValue();

    $control = id(new AphrontFormTokenizerControl())
      ->setUser($this->getViewer())
      ->setLabel($this->getFieldName())
      ->setName($this->getFieldKey())
      ->setDatasource($this->getDatasource())
      ->setCaption($this->getCaption())
      ->setError($this->getFieldError())
      ->setValue(nonempty($value, array()));

    $limit = $this->getFieldConfigValue('limit');
    if ($limit) {
      $control->setLimit($limit);
    }

    return $control;
  }

  public function appendToApplicationSearchForm(
    PhabricatorApplicationSearchEngine $engine,
    AphrontFormView $form,
    $value) {

    $control = id(new AphrontFormTokenizerControl())
      ->setLabel($this->getFieldName())
      ->setName($this->getFieldKey())
      ->setDatasource($this->newApplicationSearchDatasource())
      ->setValue(nonempty($value, array()));

    $form->appendControl($control);
  }

  public function applyApplicationSearchConstraintToQuery(
    PhabricatorApplicationSearchEngine $engine,
    PhabricatorCursorPagedPolicyAwareQuery $query,
    $value) {
    if ($value) {

      $datasource = $this->newApplicationSearchDatasource()
        ->setViewer($this->getViewer());
      $value = $datasource->evaluateTokens($value);

      $query->withApplicationSearchContainsConstraint(
        $this->newStringIndex(null),
        $value);
    }
  }

  public function getHeraldFieldValueType($condition) {
    return id(new HeraldTokenizerFieldValue())
      ->setKey('custom.'.$this->getFieldKey())
      ->setDatasource($this->getDatasource());
  }

  public function getHeraldFieldStandardType() {
    return HeraldField::STANDARD_PHID_LIST;
  }

  public function getHeraldDatasource() {
    return $this->getDatasource();
  }

  protected function getHTTPParameterType() {
    return new AphrontPHIDListHTTPParameterType();
  }

  protected function newConduitSearchParameterType() {
    return new ConduitPHIDListParameterType();
  }

  protected function newConduitEditParameterType() {
    return new ConduitPHIDListParameterType();
  }

  protected function newBulkParameterType() {
    $datasource = $this->getDatasource();

    $limit = $this->getFieldConfigValue('limit');
    if ($limit) {
      $datasource->setLimit($limit);
    }

    return id(new BulkTokenizerParameterType())
      ->setDatasource($datasource);
  }

  public function shouldAppearInHeraldActions() {
    return true;
  }

  public function getHeraldActionName() {
    return pht('Set "%s" to', $this->getFieldName());
  }

  public function getHeraldActionDescription($value) {
    $list = $this->renderHeraldHandleList($value);
    return pht('Set "%s" to: %s.', $this->getFieldName(), $list);
  }

  public function getHeraldActionEffectDescription($value) {
    return $this->renderHeraldHandleList($value);
  }

  public function getHeraldActionStandardType() {
    return HeraldAction::STANDARD_PHID_LIST;
  }

  public function getHeraldActionDatasource() {
    $datasource = $this->getDatasource();

    $limit = $this->getFieldConfigValue('limit');
    if ($limit) {
      $datasource->setLimit($limit);
    }

    return $datasource;
  }

  private function renderHeraldHandleList($value) {
    if (!is_array($value)) {
      return pht('(Invalid List)');
    } else {
      return $this->getViewer()
        ->renderHandleList($value)
        ->setAsInline(true)
        ->render();
    }
  }

  protected function newApplicationSearchDatasource() {
    $datasource = $this->getDatasource();

    return id(new PhabricatorCustomFieldApplicationSearchDatasource())
      ->setDatasource($datasource);
  }

  protected function newCommentAction() {
    $viewer = $this->getViewer();

    $datasource = $this->getDatasource()
      ->setViewer($viewer);

    $action = id(new PhabricatorEditEngineTokenizerCommentAction())
      ->setDatasource($datasource);

    $limit = $this->getFieldConfigValue('limit');
    if ($limit) {
      $action->setLimit($limit);
    }

    $value = $this->getFieldValue();
    if ($value !== null) {
      $action->setInitialValue($value);
    }

    return $action;
  }

}