class FormsStepsProgressBarBlock in Forms Steps 8

Same name in this branch

8 src/Plugin/Derivative/FormsStepsProgressBarBlock.php \Drupal\forms_steps\Plugin\Derivative\FormsStepsProgressBarBlock
8 src/Plugin/Block/FormsStepsProgressBarBlock.php \Drupal\forms_steps\Plugin\Block\FormsStepsProgressBarBlock

Provides the progress bar block.

Plugin annotation


@Block(
  id = "forms_steps_progress_bar",
  admin_label = @Translation("Forms Steps - Progress bar"),
  deriver = "Drupal\forms_steps\Plugin\Derivative\FormsStepsProgressBarBlock"
)

View source

class FormsStepsProgressBarBlock extends BlockBase implements ContainerFactoryPluginInterface {

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

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

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

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

  /**
   * WorkflowRepository.
   *
   * @var \Drupal\forms_steps\Repository\WorkflowRepository
   */
  private $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() {
    $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)) {
          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) {
    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() {

    // Set cache context as we depend on routes.
    return Cache::mergeContexts(parent::getCacheContexts(), [
      'route',
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE		constant	Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration	protected	property	The transliteration service.
BlockPluginTrait::access	public	function
BlockPluginTrait::baseConfigurationDefaults	protected	function	Returns generic default configuration for block plugins.
BlockPluginTrait::blockValidate	public	function		3
BlockPluginTrait::buildConfigurationForm	public	function	Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements.	2
BlockPluginTrait::calculateDependencies	public	function
BlockPluginTrait::defaultConfiguration	public	function		19
BlockPluginTrait::getConfiguration	public	function		1
BlockPluginTrait::getMachineNameSuggestion	public	function		1
BlockPluginTrait::getPreviewFallbackString	public	function		3
BlockPluginTrait::label	public	function
BlockPluginTrait::setConfiguration	public	function
BlockPluginTrait::setConfigurationValue	public	function
BlockPluginTrait::setTransliteration	public	function	Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm	public	function	Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration	protected	function	Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm	public	function	Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate().	1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement	protected	function	Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
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
FormsStepsProgressBarBlock::$currentRouteMatch	private	property	CurrentRouteMatch.
FormsStepsProgressBarBlock::$derivativeId	private	property	Derivative Id.
FormsStepsProgressBarBlock::$formsStepsHelper	private	property	FormsStepsHelper.
FormsStepsProgressBarBlock::$formsStepsManager	private	property	FormsStepsManager.
FormsStepsProgressBarBlock::$workflowRepository	private	property	WorkflowRepository.
FormsStepsProgressBarBlock::blockAccess	protected	function	Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
FormsStepsProgressBarBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
FormsStepsProgressBarBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
FormsStepsProgressBarBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
FormsStepsProgressBarBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FormsStepsProgressBarBlock::getCacheContexts	public	function	The cache contexts associated with this object. Overrides ContextAwarePluginBase::getCacheContexts
FormsStepsProgressBarBlock::getCacheTags	public	function	The cache tags associated with this object. Overrides ContextAwarePluginBase::getCacheTags
FormsStepsProgressBarBlock::__construct	public	function	Overrides BlockPluginTrait::__construct
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass	public	function
PluginWithFormsTrait::hasFormClass	public	function
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.
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class FormsStepsProgressBarBlock in Forms Steps 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation