class WorkflowListBuilder in Drupal 8

Provides a listing of Workflow entities.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
    • class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
      • class \Drupal\workflows\WorkflowListBuilder

File

core/modules/workflows/src/WorkflowListBuilder.php, line 16

Namespace

Drupal\workflows

class WorkflowListBuilder extends ConfigEntityListBuilder {

  /**
   * The workflow type plugin manager.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $workflowTypeManager;

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager')
      ->getStorage($entity_type
      ->id()), $container
      ->get('plugin.manager.workflows.type'));
  }

  /**
   * Constructs a new WorkflowListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage class.
   * @param \Drupal\Component\Plugin\PluginManagerInterface $workflow_type_manager
   *   The workflow type plugin manager.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, PluginManagerInterface $workflow_type_manager) {
    parent::__construct($entity_type, $storage);
    $this->workflowTypeManager = $workflow_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'workflow_admin_overview_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('Workflow');
    $header['type'] = $this
      ->t('Type');
    $header['states'] = $this
      ->t('States');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {

    /** @var \Drupal\workflows\WorkflowInterface $entity */
    $row['label'] = $entity
      ->label();
    $row['type']['data'] = [
      '#markup' => $entity
        ->getTypePlugin()
        ->label(),
    ];
    $items = array_map([
      State::class,
      'labelCallback',
    ], $entity
      ->getTypePlugin()
      ->getStates());
    $row['states']['data'] = [
      '#theme' => 'item_list',
      '#context' => [
        'list_style' => 'comma-list',
      ],
      '#items' => $items,
    ];
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build = parent::render();
    $workflow_types_count = count($this->workflowTypeManager
      ->getDefinitions());
    if ($workflow_types_count === 0) {
      $build['table']['#empty'] = $this
        ->t('There are no workflow types available. In order to create workflows you need to install a module that provides a workflow type. For example, the <a href=":content-moderation">Content Moderation</a> module provides a workflow type that enables workflows for content entities.', [
        ':content-moderation' => Url::fromRoute('system.modules_list', [], [
          'fragment' => 'module-content-moderation',
        ])
          ->toString(),
      ]);
    }
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityListBuilder::getDefaultOperations	public	function	Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations	15
ConfigEntityListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilder::load	7
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	2
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	2
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
EntityListBuilder::$entityType	protected	property	Information about the entity type.
EntityListBuilder::$entityTypeId	protected	property	The entity type ID.
EntityListBuilder::$limit	protected	property	The number of entities to list per page, or FALSE to list all entities.	3
EntityListBuilder::$storage	protected	property	The entity storage class.	1
EntityListBuilder::buildOperations	public	function	Builds a renderable list of operation links for the entity.	2
EntityListBuilder::ensureDestination	protected	function	Ensures that a destination is present on the given URL.
EntityListBuilder::getEntityIds	protected	function	Loads entity IDs using a pager sorted by the entity id.	4
EntityListBuilder::getLabel Deprecated	protected	function	Gets the label of an entity.
EntityListBuilder::getOperations	public	function	Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations	2
EntityListBuilder::getStorage	public	function	Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle	protected	function	Gets the title of the page.	1
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
WorkflowListBuilder::$workflowTypeManager	protected	property	The workflow type plugin manager.
WorkflowListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
WorkflowListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
WorkflowListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
WorkflowListBuilder::getFormId	public	function
WorkflowListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
WorkflowListBuilder::__construct	public	function	Constructs a new WorkflowListBuilder object. Overrides EntityListBuilder::__construct