WorkflowListBuilder.php

Same filename in other branches
  1. 8.9.x core/modules/workflows/src/WorkflowListBuilder.php
  2. 10 core/modules/workflows/src/WorkflowListBuilder.php
  3. 11.x core/modules/workflows/src/WorkflowListBuilder.php

Namespace

Drupal\workflows

File

core/modules/workflows/src/WorkflowListBuilder.php

View source
<?php

namespace Drupal\workflows;

use Drupal\Component\Plugin\PluginManagerInterface;
use Drupal\Core\Config\Entity\ConfigEntityListBuilder;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Url;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides a listing of Workflow entities.
 */
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;
    }

}

Classes

Title Deprecated Summary
WorkflowListBuilder Provides a listing of Workflow entities.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.