forms_steps-8.x-1.4/src/Step.php

<?php

namespace Drupal\forms_steps;

use Drupal\forms_steps\Entity\FormsSteps;

/**
 * A value object representing a step state.
 */
class Step implements StepInterface {

  /**
   * The forms_steps the step is attached to.
   *
   * @var \Drupal\forms_steps\FormsStepsInterface
   */
  protected FormsStepsInterface $formsSteps;

  /**
   * The step's ID.
   *
   * @var string
   */
  protected string $id;

  /**
   * The step's label.
   *
   * @var string
   */
  protected string $label;

  /**
   * The step's weight.
   *
   * @var int
   */
  protected int $weight;

  /**
   * The step's entity_type.
   *
   * @var string
   */
  protected string $entityType;

  /**
   * The step's entity_bundle.
   *
   * @var string
   */
  protected string $entityBundle;

  /**
   * The step's form_view_mode_id.
   *
   * @var string
   */
  protected string $formMode;

  /**
   * The step's URL.
   *
   * @var string
   */
  protected string $url;

  /**
   * The step's submit label.
   *
   * @var string
   */
  protected string $submitLabel;

  /**
   * The step's cancel label.
   *
   * @var string
   */
  protected string $cancelLabel;

  /**
   * The step's delete label.
   *
   * @var string
   */
  protected string $deleteLabel;

  /**
   * The step's cancel route.
   *
   * @var string
   */
  protected string $cancelRoute;

  /**
   * The step's cancel step.
   *
   * @var \Drupal\forms_steps\Step|null
   */
  protected ?Step $cancelStep;

  /**
   * The step's cancel step mode.
   *
   * @var string
   */
  protected string $cancelStepMode;

  /**
   * The step's delete state.
   *
   * @var bool
   */
  protected bool $hideDelete;

  /**
   * The step's previous label.
   *
   * @var string
   */
  protected string $previousLabel;

  /**
   * The step's previous state.
   *
   * @var bool
   */
  protected bool $displayPrevious;

  /**
   * Step constructor.
   *
   * @param \Drupal\forms_Steps\FormsStepsInterface $forms_steps
   *   The forms_steps the step is attached to.
   * @param string $id
   *   The step's ID.
   * @param string $label
   *   The step's label.
   * @param int $weight
   *   The step's weight.
   * @param string $entityType
   *   The step's entity type.
   * @param string $entityBundle
   *   The step's bundle.
   * @param string $formMode
   *   The step's form mode.
   * @param string $url
   *   The step's URL.
   */
  public function __construct(FormsStepsInterface $forms_steps, string $id, string $label, int $weight, string $entityType, string $entityBundle, string $formMode, string $url) {
    $this->formsSteps = $forms_steps;
    $this->id = $id;
    $this->label = $label;
    $this->weight = $weight;
    $this->entityType = $entityType;
    $this->entityBundle = $entityBundle;
    $this->formMode = $formMode;
    $this->url = $url;
    $this->submitLabel = $this->cancelLabel = $this->deleteLabel = $this->cancelRoute = $this->previousLabel = '';
    $this->cancelStep = NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function id(): string {
    return $this->id;
  }

  /**
   * {@inheritdoc}
   */
  public function label(): string {
    return $this->label;
  }

  /**
   * {@inheritdoc}
   */
  public function weight(): int {
    return $this->weight;
  }

  /**
   * {@inheritdoc}
   */
  public function entityType(): string {
    return $this->entityType;
  }

  /**
   * {@inheritdoc}
   */
  public function entityBundle(): string {
    return $this->entityBundle;
  }

  /**
   * {@inheritdoc}
   */
  public function formMode(): string {
    return $this->formMode;
  }

  /**
   * {@inheritdoc}
   */
  public function url(): string {
    return $this->url;
  }

  /**
   * Return a list of form modes available for this entity bundle.
   *
   * @return array
   *   Returns the list of form modes.
   */
  public function formModes(): array {
    $result = [];

    // Get the list of available form modes for a certain entity type.
    $form_modes = \Drupal::service('entity_display.repository')->getFormModes($this->entityType);

    foreach ($form_modes as $form_mode) {
      $result[$form_mode['id']] = $form_mode['label'];
    }

    $result['default'] = 'Default';

    return $result;
  }

  /**
   * Gets the submit label.
   *
   * @return string
   *   The submit label.
   */
  public function submitLabel(): string {
    return $this->submitLabel;
  }

  /**
   * Gets the cancel label.
   *
   * @return string
   *   The cancel label.
   */
  public function cancelLabel(): string {
    return $this->cancelLabel;
  }

  /**
   * Gets the delete label.
   *
   * @return string
   *   The delete label.
   */
  public function deleteLabel(): string {
    return $this->deleteLabel;
  }

  /**
   * Gets the cancel route.
   *
   * @return string
   *   The cancel route.
   */
  public function cancelRoute(): string {
    return $this->cancelRoute;
  }

  /**
   * Gets the cancel step.
   *
   * @return \Drupal\forms_steps\Step|null
   *   The cancel step.
   */
  public function cancelStep(): ?Step {
    return $this->cancelStep;
  }

  /**
   * Get the hidden status of the delete button.
   *
   * @return bool
   *   TRUE if hidden | FALSE otherwise
   */
  public function hideDelete(): bool {
    return $this->hideDelete;
  }

  /**
   * Set the hidden state of the delete button.
   *
   * @param bool|int $value
   *   TRUE if hidden | FALSE otherwise.
   */
  public function setHideDelete($value) {
    $this->hideDelete = $value;
  }

  /**
   * Gets the cancel step mode.
   *
   * @return string
   *   The cancel step mode.
   */
  public function cancelStepMode(): string {
    return $this->cancelStepMode;
  }

  /**
   * {@inheritdoc}
   */
  public function setSubmitLabel(string $label) {
    $this->submitLabel = $label;
  }

  /**
   * {@inheritdoc}
   */
  public function setCancelLabel(string $label) {
    $this->cancelLabel = $label;
  }

  /**
   * {@inheritdoc}
   */
  public function setDeleteLabel($label) {
    $this->deleteLabel = $label;
  }

  /**
   * {@inheritdoc}
   */
  public function setCancelRoute(string $route) {
    $this->cancelRoute = $route;
  }

  /**
   * {@inheritdoc}
   */
  public function setCancelStep(Step $step) {
    $this->cancelStep = $step;
  }

  /**
   * {@inheritdoc}
   */
  public function setCancelStepMode($mode) {
    $this->cancelStepMode = $mode;
  }

  /**
   * {@inheritdoc}
   */
  public function formsSteps(): FormsSteps {
    return $this->formsSteps;
  }

  /**
   * {@inheritdoc}
   */
  public function displayPrevious(): bool {
    return $this->displayPrevious;
  }

  /**
   * {@inheritdoc}
   */
  public function setPreviousLabel($label) {
    $this->previousLabel = $label;
  }

  /**
   * {@inheritdoc}
   */
  public function previousLabel(): string {
    return $this->previousLabel;
  }

  /**
   * {@inheritdoc}
   */
  public function setDisplayPrevious($value): bool {
    return $this->displayPrevious = $value;
  }

  /**
   * {@inheritdoc}
   */
  public function isLast(): bool {
    $last_step = $this->formsSteps->getLastStep();

    if ($this->id == $last_step->id()) {
      return TRUE;
    }

    return FALSE;
  }

}