WorkflowGroupInterface.php in State Machine 8

Namespace

Drupal\state_machine\Plugin\WorkflowGroup

File

src/Plugin/WorkflowGroup/WorkflowGroupInterface.php

<?php

namespace Drupal\state_machine\Plugin\WorkflowGroup;


/**
 * Defines the interface for workflow groups.
 */
interface WorkflowGroupInterface {

  /**
   * Gets the workflow group ID.
   *
   * @return string
   *   The workflow group ID.
   */
  public function getId();

  /**
   * Gets the translated label.
   *
   * @return string
   *   The translated label.
   */
  public function getLabel();

  /**
   * Gets the entity type ID.
   *
   * For example, "node" if all workflows in the group are used on content.
   *
   * @return string
   *   The entity type ID.
   */
  public function getEntityTypeId();

  /**
   * Gets the workflow class.
   *
   * By default all workflows use the same class. A group can choose to
   * override the class for its workflows, to satisfy advanced use cases.
   *
   * @return string
   *   The workflow class.
   */
  public function getWorkflowClass();

}

Interfaces

Name	Description
WorkflowGroupInterface	Defines the interface for workflow groups.