<?php

/*
 * Copyright 2012 Facebook, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @group maniphest
 */
final class ManiphestTaskPriority extends ManiphestConstants {

  const PRIORITY_UNBREAK_NOW  = 100;
  const PRIORITY_TRIAGE       = 90;
  const PRIORITY_HIGH         = 80;
  const PRIORITY_NORMAL       = 50;
  const PRIORITY_LOW          = 25;
  const PRIORITY_WISH         = 0;

  /**
   * Get the priorities and their full descriptions.
   *
   * @return  map Priorities to descriptions.
   */
  public static function getTaskPriorityMap() {
    return array(
      self::PRIORITY_UNBREAK_NOW  => 'Unbreak Now!',
      self::PRIORITY_TRIAGE       => 'Needs Triage',
      self::PRIORITY_HIGH         => 'High',
      self::PRIORITY_NORMAL       => 'Normal',
      self::PRIORITY_LOW          => 'Low',
      self::PRIORITY_WISH         => 'Wishlist',
    );
  }

  /**
   * Get the priorities and their related short (one-word) descriptions.
   *
   * @return  map Priorities to brief descriptions.
   */
  public static function getTaskBriefPriorityMap() {
    return array(
      self::PRIORITY_UNBREAK_NOW  => 'Unbreak!',
      self::PRIORITY_TRIAGE       => 'Triage',
      self::PRIORITY_HIGH         => 'High',
      self::PRIORITY_NORMAL       => 'Normal',
      self::PRIORITY_LOW          => 'Low',
      self::PRIORITY_WISH         => 'Wish',
    );
  }

  /**
   * Get the priorities and some bits for bitwise fun.
   *
   * @return  map Priorities to bits.
   */
  public static function getLoadMap() {
    return array(
      self::PRIORITY_UNBREAK_NOW  => 16,
      self::PRIORITY_TRIAGE       => 8,
      self::PRIORITY_HIGH         => 4,
      self::PRIORITY_NORMAL       => 2,
      self::PRIORITY_LOW          => 1,
      self::PRIORITY_WISH         => 0,
    );
  }

  /**
   * Get the lowest defined priority.
   *
   * @return  int The value of the lowest priority constant.
   */
  public static function getLowestPriority() {
    return self::PRIORITY_WISH;
  }

  /**
   * Get the highest defined priority.
   *
   * @return  int The value of the highest priority constant.
   */
  public static function getHighestPriority() {
    return self::PRIORITY_UNBREAK_NOW;
  }

  /**
   * Retrieve the full name of the priority level provided.
   *
   * @param   int     A priority level.
   * @return  string  The priority name if the level is a valid one,
   *                  or `???` if it is not.
   */
  public static function getTaskPriorityName($priority) {
    return idx(self::getTaskPriorityMap(), $priority, '???');
  }
}