src/applications/project/config/PhabricatorProjectConfigOptions.php

   1 <?php
   2
   3 final class PhabricatorProjectConfigOptions
   4   extends PhabricatorApplicationConfigOptions {
   5
   6   public function getName() {
   7     return pht('Projects');
   8   }
   9
  10   public function getDescription() {
  11     return pht('Configure Projects.');
  12   }
  13
  14   public function getIcon() {
  15     return 'fa-briefcase';
  16   }
  17
  18   public function getGroup() {
  19     return 'apps';
  20   }
  21
  22   public function getOptions() {
  23     $default_icons = PhabricatorProjectIconSet::getDefaultConfiguration();
  24     $icons_type = 'project.icons';
  25
  26     $icons_description = $this->deformat(pht(<<<EOTEXT
  27 Allows you to change and customize the available project icons.
  28
  29 You can find a list of available icons in {nav UIExamples > Icons and Images}.
  30
  31 Configure a list of icon specifications. Each icon specification should be
  32 a dictionary, which may contain these keys:
  33
  34   - `key` //Required string.// Internal key identifying the icon.
  35   - `name` //Required string.// Human-readable icon name.
  36   - `icon` //Required string.// Specifies which actual icon image to use.
  37   - `image` //Optional string.// Selects a default image. Select an image from
  38     `resources/builtins/projects/`.
  39   - `default` //Optional bool.// Selects a default icon. Exactly one icon must
  40     be selected as the default.
  41   - `disabled` //Optional bool.// If true, this icon will no longer be
  42     available for selection when creating or editing projects.
  43   - `special` //Optional string.// Marks an icon as a special icon:
  44     - `milestone` This is the icon for milestones. Exactly one icon must be
  45       selected as the milestone icon.
  46
  47 You can look at the default configuration below for an example of a valid
  48 configuration.
  49 EOTEXT
  50       ));
  51
  52     $default_colors = PhabricatorProjectIconSet::getDefaultColorMap();
  53     $colors_type = 'project.colors';
  54
  55     $colors_description = $this->deformat(pht(<<<EOTEXT
  56 Allows you to relabel project colors.
  57
  58 The list of available colors can not be expanded, but the existing colors may
  59 be given labels.
  60
  61 Configure a list of color specifications. Each color specification should be a
  62 dictionary, which may contain these keys:
  63
  64   - `key` //Required string.// The internal key identifying the color.
  65   - `name` //Required string.// Human-readable label for the color.
  66   - `default` //Optional bool.// Selects the default color used when creating
  67     new projects. Exactly one color must be selected as the default.
  68
  69 You can look at the default configuration below for an example of a valid
  70 configuration.
  71 EOTEXT
  72       ));
  73
  74     $default_fields = array(
  75       'std:project:internal:description' => true,
  76     );
  77
  78     foreach ($default_fields as $key => $enabled) {
  79       $default_fields[$key] = array(
  80         'disabled' => !$enabled,
  81       );
  82     }
  83
  84     $custom_field_type = 'custom:PhabricatorCustomFieldConfigOptionType';
  85
  86
  87     $subtype_type = 'projects.subtypes';
  88     $subtype_default_key = PhabricatorEditEngineSubtype::SUBTYPE_DEFAULT;
  89     $subtype_example = array(
  90       array(
  91         'key' => $subtype_default_key,
  92         'name' => pht('Project'),
  93       ),
  94       array(
  95         'key' => 'team',
  96         'name' => pht('Team'),
  97       ),
  98     );
  99     $subtype_example = id(new PhutilJSON())->encodeAsList($subtype_example);
 100
 101     $subtype_default = array(
 102       array(
 103         'key' => $subtype_default_key,
 104         'name' => pht('Project'),
 105       ),
 106     );
 107
 108     $subtype_description = $this->deformat(pht(<<<EOTEXT
 109 Allows you to define project subtypes. For a more detailed description of
 110 subtype configuration, see @{config:maniphest.subtypes}.
 111 EOTEXT
 112       ));
 113
 114     return array(
 115       $this->newOption('projects.custom-field-definitions', 'wild', array())
 116         ->setSummary(pht('Custom Projects fields.'))
 117         ->setDescription(
 118           pht(
 119             'Array of custom fields for Projects.'))
 120         ->addExample(
 121           '{"mycompany:motto": {"name": "Project Motto", '.
 122           '"type": "text"}}',
 123           pht('Valid Setting')),
 124       $this->newOption('projects.fields', $custom_field_type, $default_fields)
 125         ->setCustomData(id(new PhabricatorProject())->getCustomFieldBaseClass())
 126         ->setDescription(pht('Select and reorder project fields.')),
 127       $this->newOption('projects.icons', $icons_type, $default_icons)
 128         ->setSummary(pht('Adjust project icons.'))
 129         ->setDescription($icons_description),
 130       $this->newOption('projects.colors', $colors_type, $default_colors)
 131         ->setSummary(pht('Adjust project colors.'))
 132         ->setDescription($colors_description),
 133       $this->newOption('projects.subtypes', $subtype_type, $subtype_default)
 134         ->setSummary(pht('Define project subtypes.'))
 135         ->setDescription($subtype_description)
 136         ->addExample($subtype_example, pht('Simple Subtypes')),
 137
 138     );
 139   }
 140
 141 }