class WorkflowItem in Workflow 7.2

Plugin implementation of the 'workflow' field type.

Plugin annotation

@FieldType(
  id = "workflow",
  label = @Translation("Workflow"),
  description = @Translation("This field stores Workflow values for a certain Workflow type from a list of allowed 'value => label' pairs, i.e. 'Publishing': 1 => unpublished, 2 => draft, 3 => published."),
  default_widget = "options_select",
  default_formatter = "list_formatter",
  property_type' = WORKFLOWFIELD_PROPERTY_TYPE,
)

Hierarchy

• class \WorkflowD7Base
  • class \WorkflowItem

File

includes/Field/WorkflowItem.php, line 21

Contains workflow\includes\Field\WorkflowItem.

class WorkflowItem extends WorkflowD7Base {

  // D8: extends ConfigFieldItemBase implements PrepareCacheInterface {

  /**
   * Function, that gets replaced by the 'annotations' in D8. (@see comments above this class)
   */
  public static function getInfo() {
    return array(
      'workflow' => array(
        'label' => t('Workflow'),
        'description' => t("This field stores Workflow values for a certain Workflow type from a list of allowed 'value => label' pairs, i.e. 'Publishing': 1 => unpublished, 2 => draft, 3 => published."),
        'settings' => array(
          'allowed_values_function' => 'workflowfield_allowed_values',
          // For the list.module formatter
          // 'allowed_values_function' => 'WorkflowItem::getAllowedValues', // For the list.module formatter.
          'wid' => '',
          // 'history' => 1,
          // 'schedule' => 0,
          // 'comment' => 0,
          'widget' => array(
            'options' => 'select',
            'name_as_title' => 1,
            'fieldset' => 0,
            'hide' => 0,
            'schedule' => 1,
            'schedule_timezone' => 1,
            'comment' => 1,
          ),
          'watchdog_log' => 1,
          'history' => array(
            'history_tab_show' => 1,
            'roles' => array(),
          ),
        ),
        'instance_settings' => array(),
        'default_widget' => 'workflow',
        'default_formatter' => 'list_default',
        // Properties are introduced in Entity API and used for Rules integration.
        'property_type' => WORKFLOWFIELD_PROPERTY_TYPE,
        'property_callbacks' => array(
          'workflowfield_property_info_callback',
        ),
      ),
    );
  }

  /**
   * Implements hook_field_settings_form() -> ConfigFieldItemInterface::settingsForm().
   *
   * @param array $form
   * @param array $form_state
   * @param $has_data
   *
   * @return array $element
   *   The newly constructed element.
   */
  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;
  }

  /**
   * Implements hook_field_insert() -> FieldItemInterface::insert().
   */
  public function insert() {
    return $this
      ->update();
  }

  /**
   * Helper functions for the Field Settings page.
   *
   * Generates a string representation of an array of 'allowed values'.
   * This is a copy from list.module's list_allowed_values_string().
   * The string format is suitable for edition in a textarea.
   *
   * @param int $wid
   *   The Workflow Id.
   *
   * @return string
   * The string representation of the $values array:
   * - Values are separated by a carriage return.
   * - Each value is in the format "value|label" or "value".
   */
  protected function _allowed_values_string($wid = 0) {
    $lines = array();
    $states = workflow_state_load_multiple($wid);
    $previous_wid = -1;

    /* @var $state WorkflowState */
    foreach ($states as $state) {

      // Only show enabled states.
      if ($state
        ->isActive()) {

        // Show a Workflow name between Workflows, if more then 1 in the list.
        if ($wid == 0 && $previous_wid != $state->wid) {
          $previous_wid = $state->wid;
          $lines[] = $state->name . "'s states: ";
        }
        $label = $state
          ->label();
        $states[$state->sid] = $label;
        $lines[] = $state->sid . ' | ' . $label;
      }
    }
    return implode("\n", $lines);
  }

  /**
   * Helper function for list.module formatter.
   *
   * Callback function for the list module formatter.
   *
   * @see list_allowed_values
   *   "The strings are not safe for output. Keys and values of the array should
   *   "be sanitized through field_filter_xss() before being displayed.
   *
   * @return array
   *   The array of allowed values. Keys of the array are the raw stored values
   *   (number or text), values of the array are the display labels.
   *   It contains all possible values for the field, because the result is
   *   cached on a field basis, and used for all nodes on a page.
   */
  public function getAllowedValues() {

    // Get all state names, including inactive states.
    $wid = isset($this->field['settings']['wid']) ? $this->field['settings']['wid'] : 0;
    $options = workflow_get_workflow_state_names($wid, $grouped = FALSE, $all = TRUE);
    return $options;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
WorkflowD7Base::$entity	protected	property
WorkflowD7Base::$entity_type	protected	property
WorkflowD7Base::$field	protected	property
WorkflowD7Base::$instance	protected	property
WorkflowD7Base::delete	public	function
WorkflowD7Base::getField	public	function
WorkflowD7Base::getInstance	public	function
WorkflowD7Base::getSetting	protected	function
WorkflowD7Base::getSettings	protected	function
WorkflowD7Base::__construct	public	function	Constructor, stub for D8 WidgetBase.
WorkflowItem::getAllowedValues	public	function	Helper function for list.module formatter.
WorkflowItem::getInfo	public static	function	Function, that gets replaced by the 'annotations' in D8. (
WorkflowItem::insert	public	function	Implements hook_field_insert() -> FieldItemInterface::insert().
WorkflowItem::settingsForm	public	function	Implements hook_field_settings_form() -> ConfigFieldItemInterface::settingsForm().
WorkflowItem::_allowed_values_string	protected	function	Helper functions for the Field Settings page.