workflow-8.x-1.x-dev/src/Entity/WorkflowConfigTransitionInterface.php

<?php

namespace Drupal\workflow\Entity;

use Drupal\user\UserInterface;
use Drupal\workflow\WorkflowTypeAttributeInterface;

/**
 * Defines a common interface for Workflow*Transition* objects.
 *
 * @see \Drupal\workflow\Entity\WorkflowConfigTransition
 * @see \Drupal\workflow\Entity\WorkflowTransition
 * @see \Drupal\workflow\Entity\WorkflowScheduledTransition
 */
interface WorkflowConfigTransitionInterface extends WorkflowTypeAttributeInterface {

  /**
   * Determines if the current transition between 2 states is allowed.
   *
   * This is checked in the following locations:
   * - in settings;
   * - in permissions;
   * - by permission hooks, implemented by other modules.
   *
   * @param \Drupal\user\UserInterface $user
   *   The user to act upon.
   *   May have the custom WorkflowRole role.
   * @param bool $force
   *   Indicates if the transition must be forced(E.g., by Cron, Rules).
   *
   * @return bool
   *   TRUE if OK, else FALSE.
   */
  public function isAllowed(UserInterface $user, $force = FALSE): bool;

  /**
   * Gets the 'from' State object.
   *
   * @return \Drupal\workflow\Entity\WorkflowState
   *   A WorkflowState object.
   */
  public function getFromState(): ?WorkflowState;

  /**
   * Gets the 'to' State object.
   *
   * @return \Drupal\workflow\Entity\WorkflowState
   *   A WorkflowState object.
   */
  public function getToState(): ?WorkflowState;

  /**
   * Gets the 'from' State ID.
   *
   * @return string
   *   A WorkflowState ID.
   */
  public function getFromSid(): string;

  /**
   * Gets the 'from' State object.
   *
   * @return string
   *   A WorkflowState ID.
   */
  public function getToSid(): string;

  /**
   * Determines if the State changes by this Transition.
   *
   * @return bool
   *   TRUE if the From state ID and To state ID are different.
   */
  public function hasStateChange(): bool;

}