Differential D20810 Diff 49617 src/applications/maniphest/config/PhabricatorManiphestConfigOptions.php
Changeset View
Changeset View
Standalone View
Standalone View
src/applications/maniphest/config/PhabricatorManiphestConfigOptions.php
Show First 20 Lines • Show All 338 Lines • ▼ Show 20 Lines | dictionary with these keys: | ||||
- `name` //Required string.// Human-readable name for this subtype, like | - `name` //Required string.// Human-readable name for this subtype, like | ||||
"Task", "Feature Request" or "Bug Report". | "Task", "Feature Request" or "Bug Report". | ||||
- `tag` //Optional string.// Tag text for this subtype. | - `tag` //Optional string.// Tag text for this subtype. | ||||
- `color` //Optional string.// Display color for this subtype. | - `color` //Optional string.// Display color for this subtype. | ||||
- `icon` //Optional string.// Icon for the subtype. | - `icon` //Optional string.// Icon for the subtype. | ||||
- `children` //Optional map.// Configure options shown to the user when | - `children` //Optional map.// Configure options shown to the user when | ||||
they "Create Subtask". See below. | they "Create Subtask". See below. | ||||
- `fields` //Optional map.// Configure field behaviors. See below. | - `fields` //Optional map.// Configure field behaviors. See below. | ||||
- `mutations` //Optional list.// Configure which subtypes this subtype | |||||
can easily be converted to by using the "Change Subtype" action. See below. | |||||
Each subtype must have a unique key, and you must define a subtype with | Each subtype must have a unique key, and you must define a subtype with | ||||
the key "%s", which is used as a default subtype. | the key "%s", which is used as a default subtype. | ||||
The tag text (`tag`) is used to set the text shown in the subtype tag on list | The tag text (`tag`) is used to set the text shown in the subtype tag on list | ||||
views and workboards. If you do not configure it, the default subtype will have | views and workboards. If you do not configure it, the default subtype will have | ||||
no subtype tag and other subtypes will use their name as tag text. | no subtype tag and other subtypes will use their name as tag text. | ||||
▲ Show 20 Lines • Show All 44 Lines • ▼ Show 20 Lines | |||||
If only one option would be presented, the user will be taken directly to the | If only one option would be presented, the user will be taken directly to the | ||||
appropriate form instead of being prompted to choose a form. | appropriate form instead of being prompted to choose a form. | ||||
The `fields` key can configure the behavior of custom fields on specific | The `fields` key can configure the behavior of custom fields on specific | ||||
task subtypes. For example: | task subtypes. For example: | ||||
``` | ``` | ||||
{ | { | ||||
... | ... | ||||
"fields": { | "fields": { | ||||
"custom.some-field": { | "custom.some-field": { | ||||
"disabled": true | "disabled": true | ||||
} | } | ||||
} | } | ||||
... | ... | ||||
} | } | ||||
``` | ``` | ||||
Each field supports these options: | Each field supports these options: | ||||
- `disabled` //Optional bool.// Allows you to disable fields on certain | - `disabled` //Optional bool.// Allows you to disable fields on certain | ||||
subtypes. | subtypes. | ||||
- `name` //Optional string.// Custom name of this field for the subtype. | - `name` //Optional string.// Custom name of this field for the subtype. | ||||
The `mutations` key allows you to control the behavior of the "Change Subtype" | |||||
action above the comment area. By default, this action allows users to change | |||||
the task subtype into any other subtype. | |||||
If you'd prefer to make it more difficult to change subtypes or offer only a | |||||
subset of subtypes, you can specify the list of subtypes that "Change Subtypes" | |||||
offers. For example, if you have several similar subtypes and want to allow | |||||
tasks to be converted between them but not easily converted to other types, | |||||
you can make the "Change Subtypes" control show only these options like this: | |||||
``` | |||||
{ | |||||
... | |||||
"mutations": ["bug", "issue", "defect"] | |||||
... | |||||
} | |||||
``` | |||||
If you specify an empty list, the "Change Subtypes" action will be completely | |||||
hidden. | |||||
This mutation list is advisory and only configures the UI. Tasks may still be | |||||
converted across subtypes freely by using the Bulk Editor or API. | |||||
EOTEXT | EOTEXT | ||||
, | , | ||||
$subtype_default_key)); | $subtype_default_key)); | ||||
$priorities_description = $this->deformat(pht(<<<EOTEXT | $priorities_description = $this->deformat(pht(<<<EOTEXT | ||||
Allows you to edit or override the default priorities available in Maniphest, | Allows you to edit or override the default priorities available in Maniphest, | ||||
like "High", "Normal" and "Low". The configuration should contain a map of | like "High", "Normal" and "Low". The configuration should contain a map of | ||||
numeric priority values (where larger numbers correspond to higher priorities) | numeric priority values (where larger numbers correspond to higher priorities) | ||||
▲ Show 20 Lines • Show All 72 Lines • Show Last 20 Lines |