public function WorkflowItem::settingsForm in Workflow 7.2
Same name and namespace in other branches
- 7 includes/Field/WorkflowItem.php \WorkflowItem::settingsForm()
Implements hook_field_settings_form() -> ConfigFieldItemInterface::settingsForm().
_state
Parameters
array $form:
$has_data:
Return value
array $element The newly constructed element.
File
- includes/
Field/ WorkflowItem.php, line 72 - Contains workflow\includes\Field\WorkflowItem.
Class
- WorkflowItem
- Plugin implementation of the 'workflow' field type.
Code
public function settingsForm(array $form, array &$form_state, $has_data) {
$field_info = self::getInfo();
$settings = $this->field['settings'];
$settings += $field_info['workflow']['settings'];
$settings['widget'] += $field_info['workflow']['settings']['widget'];
// Create list of all Workflow types. Include an initial empty value.
// Validate each workflow, and generate a message if not complete.
/* @var $workflow Workflow */
$workflows = array();
$workflows[''] = t('- Select a value -');
foreach ($workflows += workflow_get_workflow_names() as $wid => $label) {
$workflow = workflow_load_single($wid);
if ($wid && !$workflow
->isValid()) {
unset($workflows[$wid]);
}
}
// Set message, if no 'validated' workflows exist.
if (count($workflows) == 1) {
drupal_set_message(t('You must create at least one workflow before content can be
assigned to a workflow.'));
}
// The allowed_values_functions is used in the formatter from list.module.
$element['allowed_values_function'] = array(
'#type' => 'value',
'#value' => $settings['allowed_values_function'],
);
// $field['settings']['wid'] can be numeric or named, or empty.
$wid = isset($settings['wid']) ? $settings['wid'] : '';
// Let the user choose between the available workflow types.
$element['wid'] = array(
'#type' => 'select',
'#title' => t('Workflow type'),
'#options' => $workflows,
'#default_value' => $wid,
'#required' => TRUE,
'#disabled' => $has_data,
'#description' => t('Choose the Workflow type. Maintain workflows !url.', array(
'!url' => l(t('here'), WORKFLOW_ADMIN_UI_PATH),
)),
);
// Inform the user of possible states.
// If no Workflow type is selected yet, do not show anything.
if ($wid) {
// Get a string representation to show all options.
$allowed_values = workflow_state_load_multiple($wid);
$allowed_values_string = $this
->_allowed_values_string($wid);
$element['allowed_values_string'] = array(
'#type' => 'textarea',
'#title' => t('Allowed values for the selected Workflow type'),
'#default_value' => $allowed_values_string,
'#rows' => count($allowed_values),
'#access' => TRUE,
// User can see the data,
'#disabled' => TRUE,
);
}
$element['widget'] = array(
'#type' => 'fieldset',
'#title' => t('Workflow widget'),
'#description' => t('Set some global properties of the widgets for this
workflow. Some can be altered per widget instance.'),
);
$fieldset_options = array(
0 => t('No fieldset'),
1 => t('Collapsible fieldset'),
2 => t('Collapsed fieldset'),
);
$element['widget']['fieldset'] = array(
'#type' => 'select',
'#options' => $fieldset_options,
'#title' => t('Show the form in a fieldset?'),
'#default_value' => $settings['widget']['fieldset'],
'#description' => t("The Widget can be wrapped in a visible fieldset. You'd\n do this when you use the widget on a Node Edit page."),
);
$element['widget']['options'] = array(
'#type' => 'select',
'#title' => t('How to show the available states'),
'#required' => FALSE,
'#default_value' => $settings['widget']['options'],
// '#multiple' => TRUE / FALSE,
'#options' => array(
// These options are taken from options.module
'select' => 'Select list',
'radios' => 'Radio buttons',
// This option does not work properly on Comment Add form.
'buttons' => 'Action buttons',
),
'#description' => t("The Widget shows all available states. Decide which\n is the best way to show them. ('Action buttons' do not work on Comment form.)"),
);
$element['widget']['hide'] = array(
'#type' => 'checkbox',
'#attributes' => array(
'class' => array(
'container-inline',
),
),
'#title' => t('Hide the widget on Entity form.'),
'#default_value' => $settings['widget']['hide'],
'#description' => t('Using Workflow Field, the widget is always shown when editing an
Entity. Set this checkbox in case you only want to change the status
on the Workflow History tab or on the Node View. (This checkbox is
only needed because Drupal core does not have a "hidden" widget.)'),
);
$element['widget']['name_as_title'] = array(
'#type' => 'checkbox',
'#attributes' => array(
'class' => array(
'container-inline',
),
),
'#title' => t('Use the workflow name as the title of the workflow form'),
'#default_value' => $settings['widget']['name_as_title'],
'#description' => t('The workflow section of the editing form is in its own fieldset.
Checking the box will add the workflow name as the title of workflow
section of the editing form.'),
);
$element['widget']['schedule'] = array(
'#type' => 'checkbox',
'#title' => t('Allow scheduling of workflow transitions.'),
'#required' => FALSE,
'#default_value' => $settings['widget']['schedule'],
'#description' => t('Workflow transitions may be scheduled to a moment in the future.
Soon after the desired moment, the transition is executed by Cron.
This may be hidden by settings in widgets, formatters or permissions.'),
);
$element['widget']['schedule_timezone'] = array(
'#type' => 'checkbox',
'#title' => t('Show a timezone when scheduling a transition.'),
'#required' => FALSE,
'#default_value' => $settings['widget']['schedule_timezone'],
);
$element['widget']['comment'] = array(
'#type' => 'select',
'#title' => t('Allow adding a comment to workflow transitions'),
'#required' => FALSE,
'#options' => array(
// Use 0/1/2 to stay compatible with previous checkbox.
0 => t('hidden'),
1 => t('optional'),
2 => t('required'),
),
'#default_value' => $settings['widget']['comment'],
'#description' => t('On the Workflow form, a Comment form can be included
so that the person making the state change can record reasons for doing
so. The comment is then included in the node\'s workflow history. This
may be altered by settings in widgets, formatters or permissions.'),
);
$element['watchdog_log'] = array(
'#type' => 'checkbox',
'#attributes' => array(
'class' => array(
'container-inline',
),
),
'#title' => t('Log informational watchdog messages when a transition is
executed (a state value is changed)'),
'#default_value' => $settings['watchdog_log'],
'#description' => t('Optionally log transition state changes to watchdog.'),
);
$element['history'] = array(
'#type' => 'fieldset',
'#title' => t('Workflow history'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
);
$element['history']['history_tab_show'] = array(
'#type' => 'checkbox',
'#title' => t('Use the workflow history, and show it on a separate tab.'),
'#required' => FALSE,
'#default_value' => $settings['history']['history_tab_show'],
'#description' => t("Every state change is recorded in table\n {workflow_node_history}. If checked and user has proper permission, a\n tab 'Workflow' is shown on the entity view page, which gives access to\n the History of the workflow. If you have multiple workflows per bundle,\n better disable this feature, and use, clone & adapt the Views display\n 'Workflow history per Entity'."),
);
$element['history']['roles'] = array(
'#type' => 'checkboxes',
'#options' => workflow_get_roles(),
'#title' => t('Workflow history permissions'),
'#default_value' => $settings['history']['roles'],
'#description' => t('Select any roles that should have access to the workflow tab on nodes that have a workflow.'),
);
return $element;
}