forms_steps-8.x-1.4/src/Plugin/Block/FormsStepsProgressBarBlock.php

<?php

declare(strict_types=1);

namespace Drupal\forms_steps\Plugin\Block;

use Drupal\Core\Routing\CurrentRouteMatch;
use Drupal\Core\Url;
use Drupal\Core\Link;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Block\BlockBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\forms_steps\Repository\WorkflowRepository;
use Drupal\forms_steps\Service\FormsStepsHelper;
use Drupal\forms_steps\Service\FormsStepsManager;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides the progress bar block.
 *
 * @Block(
 *   id = "forms_steps_progress_bar",
 *   admin_label = @Translation("Forms Steps - Progress bar"),
 *   deriver = "Drupal\forms_steps\Plugin\Derivative\FormsStepsProgressBarBlock"
 * )
 */
class FormsStepsProgressBarBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * Derivative Id.
   *
   * @var string|null
   */
  private $derivativeId;

  /**
   * CurrentRouteMatch.
   *
   * @var \Drupal\Core\Routing\CurrentRouteMatch
   */
  private CurrentRouteMatch $currentRouteMatch;

  /**
   * FormsStepsManager.
   *
   * @var \Drupal\forms_steps\Service\FormsStepsManager
   */
  private FormsStepsManager $formsStepsManager;

  /**
   * FormsStepsHelper.
   *
   * @var \Drupal\forms_steps\Service\FormsStepsHelper
   */
  private FormsStepsHelper $formsStepsHelper;

  /**
   * WorkflowRepository.
   *
   * @var \Drupal\forms_steps\Repository\WorkflowRepository
   */
  private WorkflowRepository $workflowRepository;

  /**
   * {@inheritdoc}
   */
  public function __construct(
    array $configuration,
    $plugin_id,
    $plugin_definition,
    CurrentRouteMatch $current_route_match,
    FormsStepsManager $forms_steps_manager,
    FormsStepsHelper $forms_steps_helper,
    WorkflowRepository $workflow_repository
  ) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);

    $this->derivativeId = $this->getDerivativeId();
    $this->currentRouteMatch = $current_route_match;
    $this->formsStepsManager = $forms_steps_manager;
    $this->formsStepsHelper = $forms_steps_helper;
    $this->workflowRepository = $workflow_repository;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static(
      $configuration,
      $plugin_id,
      $plugin_definition,
      $container->get('current_route_match'),
      $container->get('forms_steps.manager'),
      $container->get('forms_steps.helper'),
      $container->get('forms_steps.workflow.repository')
    );
  }

  /**
   * {@inheritdoc}
   */
  public function build(): array {
    $route = $this->currentRouteMatch->getRouteName();

    /** @var \Drupal\forms_steps\Step $step */
    $step = $this->formsStepsManager->getStepByRoute($route);

    // The block is rendered only if the current route is a forms steps route.
    if ($step) {
      /** @var \Drupal\forms_steps\FormsStepsInterface $forms_steps */
      $forms_steps = $step->formsSteps();

      // If the derivative id is the current step, we display
      // the corresponding progress steps.
      if ($forms_steps->id() === $this->derivativeId) {
        $items = [];
        $item_class = 'previous-step';

        // Retrieve current workflow instance_id to add it to the link.
        $instanceId = $this->formsStepsHelper->getWorkflowInstanceIdFromRoute();
        $saved_steps = $this->workflowRepository->load(['instance_id' => $instanceId]);

        foreach ($forms_steps->getProgressSteps() as $progress_step) {
          $item = [];

          // Prepare the current progress step content regarding
          // the existence of a link and its visibility configuration.
          $link_visibility = array_filter($progress_step->linkVisibility());

          if ($forms_steps->getProgressStepsLinksSavedOnly() && !empty($saved_steps)) {
            $saved_steps_flat = [];
            foreach ($saved_steps as $saved_step) {
              $saved_steps_flat[$saved_step->step] = $saved_step->step;
            }

            if ($forms_steps->getProgressStepsLinksSavedOnlyNext()) {
              $saved_step_last = end($saved_steps);
              $saved_step_last_entity = $forms_steps->getStep($saved_step_last->step);
              $saved_step_next = $forms_steps->getNextStep($saved_step_last_entity);
              if ($saved_step_next) {
                $saved_steps_flat[$saved_step_next->id()] = $saved_step_next->id();
              }
            }
            $link_visibility_check = !in_array($progress_step->link(), $saved_steps_flat);
          }
          else {
            $link_visibility_check = !in_array($step->id(), $link_visibility);
          }

          // Display a simple label or the link.
          // @todo Manage the specific case of "No workflow instance id" for
          // the first step to avoid having no links at all on this step.
          if (empty($progress_step->link()) || $link_visibility_check || empty($instanceId)) {
            $item['#markup'] = $this->t($progress_step->label());
          }
          else {
            $link_step = $forms_steps->getStep($progress_step->link());
            $options = [];
            if ($instanceId) {
              $options['instance_id'] = $instanceId;
            }
            $url = Url::fromRoute($forms_steps->getStepRoute($link_step), $options);
            $link = Link::fromTextAndUrl($this->t($progress_step->label()), $url);
            $toRenderable = $link->toRenderable();
            $markup = \Drupal::service('renderer')->renderPlain($toRenderable);

            $item['#markup'] = $markup->__toString();
          }
          $routes = $progress_step->activeRoutes();
          array_filter($routes);

          // Defined the active status.
          $active = FALSE;
          foreach ($routes as $route) {
            if ($route === $step->id()) {
              $active = TRUE;
              break;
            }
          }

          // Set classes.
          if ($active) {
            $item['#wrapper_attributes']['class'][] = 'active';
            $item_class = 'next-step';
          }
          else {
            $item['#wrapper_attributes']['class'][] = $item_class;
          }

          // Add item to the items list.
          $items[] = $item;
        }

        return [
          '#theme' => [
            'item_list__forms_steps',
            'item_list',
          ],
          '#list_type' => 'ol',
          '#title' => '',
          '#items' => $items,
          '#cache' => [
            'max-age' => 0,
          ],
        ];
      }
    }

    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function blockAccess(AccountInterface $account) {
    return AccessResult::allowedIfHasPermission($account, 'access content');
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state): array {
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['progress_bar_settings'] = $form_state->getValue('progress_bar_settings');
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    $route = $this->currentRouteMatch->getRouteName();

    /** @var \Drupal\forms_steps\Step $step */
    $step = $this->formsStepsManager->getStepByRoute($route);

    // Rebuild cache if the step is a new one.
    if ($step) {
      return Cache::mergeTags(parent::getCacheTags(), ['forms_steps_step:' . $step->id()]);
    }
    else {
      return parent::getCacheTags();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts(): array {
    // Set cache context as we depend on routes.
    return Cache::mergeContexts(parent::getCacheContexts(), ['route']);
  }

}