class ModerationStateTransitionListBuilder in Workbench Moderation 8

Provides a listing of Moderation state transition 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\Core\Config\Entity\DraggableListBuilder implements FormInterface
        • class \Drupal\workbench_moderation\ModerationStateTransitionListBuilder

File

src/ModerationStateTransitionListBuilder.php, line 14

Namespace

Drupal\workbench_moderation

class ModerationStateTransitionListBuilder extends DraggableListBuilder {

  /**
   * Entity state storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $stateStorage;

  /**
   * {@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('entity_type.manager')
      ->getStorage('moderation_state'));
  }

  /**
   * Constructs a new ModerationStateTransitionListBuilder.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type service.
   * @param \Drupal\Core\Entity\EntityStorageInterface $transition_storage
   *   Entity transition storage.
   * @param \Drupal\Core\Entity\EntityStorageInterface $state_storage
   *   Entity state storage.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $transition_storage, EntityStorageInterface $state_storage) {
    parent::__construct($entity_type, $transition_storage);
    $this->stateStorage = $state_storage;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('Moderation state transition');
    $header['id'] = $this
      ->t('Machine name');
    $header['from'] = $this
      ->t('From state');
    $header['to'] = $this
      ->t('To state');
    return $header + parent::buildHeader();
  }

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

    /** @var ModerationStateTransitionInterface $entity */
    $row['label'] = $entity
      ->label();
    $row['id']['#markup'] = $entity
      ->id();
    $row['from']['#markup'] = $this->stateStorage
      ->load($entity
      ->getFromState())
      ->label();
    $row['to']['#markup'] = $this->stateStorage
      ->load($entity
      ->getToState())
      ->label();
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build = parent::render();
    $build['item'] = [
      '#type' => 'item',
      '#markup' => $this
        ->t('When saving an entity, only a destination state that has a transition is legal. That includes its current state. If you want to allow an entity to be saved without changing its state then you must define a transition from that state to itself. Note that all users will still need permission to use a defined transition.'),
      '#weight' => -5,
    ];
    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
DraggableListBuilder::$entities	protected	property	The entities being listed.	1
DraggableListBuilder::$entitiesKey	protected	property	The key to use for the form element containing the entities.	3
DraggableListBuilder::$formBuilder	protected	property	The form builder.
DraggableListBuilder::$limit	protected	property	The number of entities to list per page, or FALSE to list all entities. Overrides EntityListBuilder::$limit
DraggableListBuilder::$weightKey	protected	property	Name of the entity's weight field or FALSE if no field is provided.
DraggableListBuilder::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm	4
DraggableListBuilder::formBuilder	protected	function	Returns the form builder.
DraggableListBuilder::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm	5
DraggableListBuilder::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	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::$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.
ModerationStateTransitionListBuilder::$stateStorage	protected	property	Entity state storage.
ModerationStateTransitionListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides DraggableListBuilder::buildHeader
ModerationStateTransitionListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides DraggableListBuilder::buildRow
ModerationStateTransitionListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
ModerationStateTransitionListBuilder::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ModerationStateTransitionListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides DraggableListBuilder::render
ModerationStateTransitionListBuilder::__construct	public	function	Constructs a new ModerationStateTransitionListBuilder. Overrides DraggableListBuilder::__construct
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.