DifferentialRevisionStatus.php

<?php

final class DifferentialRevisionStatus extends Phobject {

  const NEEDS_REVIEW = 'needs-review';
  const NEEDS_REVISION = 'needs-revision';
  const CHANGES_PLANNED = 'changes-planned';
  const ACCEPTED = 'accepted';
  const PUBLISHED = 'published';
  const ABANDONED = 'abandoned';
  const DRAFT = 'draft';

  private $key;
  private $spec = array();

  public function getKey() {
    return $this->key;
  }

  public function getLegacyKey() {
    return idx($this->spec, 'legacy');
  }

  public function getIcon() {
    return idx($this->spec, 'icon');
  }

  public function getIconColor() {
    return idx($this->spec, 'color.icon', 'bluegrey');
  }

  public function getTagColor() {
    return idx($this->spec, 'color.tag', 'bluegrey');
  }

  public function getTimelineIcon() {
    return idx($this->spec, 'icon.timeline');
  }

  public function getTimelineColor() {
    return idx($this->spec, 'color.timeline');
  }

  public function getANSIColor() {
    return idx($this->spec, 'color.ansi');
  }

  public function getDisplayName() {
    return idx($this->spec, 'name');
  }

  public function isClosedStatus() {
    return idx($this->spec, 'closed');
  }

  public function isAbandoned() {
    return ($this->key === self::ABANDONED);
  }

  public function isAccepted() {
    return ($this->key === self::ACCEPTED);
  }

  public function isNeedsReview() {
    return ($this->key === self::NEEDS_REVIEW);
  }

  public function isNeedsRevision() {
    return ($this->key === self::NEEDS_REVISION);
  }

  public function isPublished() {
    return ($this->key === self::PUBLISHED);
  }

  public function isChangePlanned() {
    return ($this->key === self::CHANGES_PLANNED);
  }

  public function isDraft() {
    return ($this->key === self::DRAFT);
  }

  public static function newForStatus($status) {
    $result = new self();

    $map = self::getMap();
    if (isset($map[$status])) {
      $result->key = $status;
      $result->spec = $map[$status];
    }

    return $result;
  }

  public static function getAll() {
    $result = array();

    foreach (self::getMap() as $key => $spec) {
      $result[$key] = self::newForStatus($key);
    }

    return $result;
  }

  private static function getMap() {
    $close_on_accept = PhabricatorEnv::getEnvConfig(
      'differential.close-on-accept');

    return array(
      self::NEEDS_REVIEW => array(
        'name' => pht('Needs Review'),
        'legacy' => 0,
        'icon' => 'fa-code',
        'icon.timeline' => 'fa-undo',
        'closed' => false,
        'color.icon' => 'grey',
        'color.tag' => 'bluegrey',
        'color.ansi' => 'magenta',
        'color.timeline' => 'orange',
      ),
      self::NEEDS_REVISION => array(
        'name' => pht('Needs Revision'),
        'legacy' => 1,
        'icon' => 'fa-refresh',
        'icon.timeline' => 'fa-times',
        'closed' => false,
        'color.icon' => 'red',
        'color.tag' => 'red',
        'color.ansi' => 'red',
        'color.timeline' => 'red',
      ),
      self::CHANGES_PLANNED => array(
        'name' => pht('Changes Planned'),
        'legacy' => 5,
        'icon' => 'fa-headphones',
        'closed' => false,
        'color.icon' => 'red',
        'color.tag' => 'red',
        'color.ansi' => 'red',
      ),
      self::ACCEPTED => array(
        'name' => pht('Accepted'),
        'legacy' => 2,
        'icon' => 'fa-check',
        'icon.timeline' => 'fa-check',
        'closed' => $close_on_accept,
        'color.icon' => 'green',
        'color.tag' => 'green',
        'color.ansi' => 'green',
        'color.timeline' => 'green',
      ),
      self::PUBLISHED => array(
        'name' => pht('Closed'),
        'legacy' => 3,
        'icon' => 'fa-check-square-o',
        'closed' => true,
        'color.icon' => 'black',
        'color.tag' => 'indigo',
        'color.ansi' => 'cyan',
      ),
      self::ABANDONED => array(
        'name' => pht('Abandoned'),
        'legacy' => 4,
        'icon' => 'fa-plane',
        'closed' => true,
        'color.icon' => 'black',
        'color.tag' => 'indigo',
        'color.ansi' => null,
      ),
      self::DRAFT => array(
        'name' => pht('Draft'),
        // For legacy clients, treat this as though it is "Needs Review".
        'legacy' => 0,
        'icon' => 'fa-spinner',
        'closed' => false,
        'color.icon' => 'pink',
        'color.tag' => 'pink',
        'color.ansi' => null,
      ),
    );
  }

}