class WebformBreadcrumbBuilder in Webform 6.x

Provides a webform breadcrumb builder.

Hierarchy

• class \Drupal\webform\Breadcrumb\WebformBreadcrumbBuilder implements BreadcrumbBuilderInterface uses StringTranslationTrait

1 string reference to 'WebformBreadcrumbBuilder'

webform.services.yml in ./webform.services.yml

webform.services.yml

1 service uses WebformBreadcrumbBuilder

webform.breadcrumb in ./webform.services.yml

Drupal\webform\Breadcrumb\WebformBreadcrumbBuilder

File

src/Breadcrumb/WebformBreadcrumbBuilder.php, line 21

Namespace

Drupal\webform\Breadcrumb

class WebformBreadcrumbBuilder implements BreadcrumbBuilderInterface {
  use StringTranslationTrait;

  /**
   * The current route's entity or plugin type.
   *
   * @var string
   */
  protected $type;

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The configuration object factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * The webform request handler.
   *
   * @var \Drupal\webform\WebformRequestInterface
   */
  protected $requestHandler;

  /**
   * Constructs a WebformBreadcrumbBuilder object.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   * @param \Drupal\webform\WebformRequestInterface $request_handler
   *   The webform request handler.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The string translation service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration object factory.
   */
  public function __construct(ModuleHandlerInterface $module_handler, WebformRequestInterface $request_handler, TranslationInterface $string_translation, ConfigFactoryInterface $config_factory = NULL) {
    $this->moduleHandler = $module_handler;
    $this->requestHandler = $request_handler;
    $this
      ->setStringTranslation($string_translation);
    $this->configFactory = $config_factory ?: \Drupal::configFactory();
  }

  /**
   * {@inheritdoc}
   */
  public function applies(RouteMatchInterface $route_match) {
    $route_name = $route_match
      ->getRouteName();

    // All routes must begin or contain 'webform.
    if (strpos($route_name, 'webform') === FALSE) {
      return FALSE;
    }
    $args = explode('.', $route_name);

    // Skip all config_translation routes except the overview
    // and allow Drupal to use the path as the breadcrumb.
    if (strpos($route_name, 'config_translation') !== FALSE && !in_array($route_name, [
      'entity.webform.config_translation_overview',
      'config_translation.item.overview.webform.config',
      'config_translation.item.add.webform.config',
      'config_translation.item.edit.webform.config',
      'config_translation.item.delete.webform.config',
    ])) {
      return FALSE;
    }
    try {
      $path = Url::fromRouteMatch($route_match)
        ->toString();
    } catch (\Exception $exception) {
      $path = '';
    }

    /** @var \Drupal\webform\WebformInterface $webform */
    $webform = $route_match
      ->getParameter('webform') instanceof WebformInterface ? $route_match
      ->getParameter('webform') : NULL;

    /** @var \Drupal\webform\WebformSubmissionInterface $webform_submission */
    $webform_submission = $route_match
      ->getParameter('webform_submission') instanceof WebformSubmissionInterface ? $route_match
      ->getParameter('webform_submission') : NULL;
    if (count($args) > 2 && $args[0] === 'entity' && ($args[2] === 'webform' || $args[2] === 'webform_submission')) {
      $this->type = 'webform_source_entity';
    }
    elseif ($route_name === 'webform.reports_plugins.elements.test') {
      $this->type = 'webform_plugins_elements';
    }
    elseif (strpos($route_name, 'webform.help.') === 0) {
      $this->type = 'webform_help';
    }
    elseif (strpos($route_name, 'entity.webform_ui.element') === 0) {
      $this->type = 'webform_element';
    }
    elseif (strpos($route_name, 'entity.webform.handler.') === 0) {
      $this->type = 'webform_handler';
    }
    elseif (strpos($route_name, 'entity.webform.variant.') === 0) {
      $this->type = 'webform_variant';
    }
    elseif ($webform_submission && strpos($route_name, '.webform.user.submission') !== FALSE) {
      $this->type = 'webform_user_submission';
    }
    elseif (strpos($route_name, '.webform.user.submissions') !== FALSE) {
      $this->type = 'webform_user_submissions';
    }
    elseif (strpos($route_name, '.webform.user.drafts') !== FALSE) {
      $this->type = 'webform_user_drafts';
    }
    elseif ($webform_submission && $webform_submission
      ->access('admin')) {
      $this->type = 'webform_submission';
    }
    elseif ($webform && $webform
      ->access('admin')) {
      $this->type = $webform
        ->isTemplate() && $this->moduleHandler
        ->moduleExists('webform_templates') ? 'webform_template' : 'webform';
    }
    elseif (strpos($path, 'admin/structure/webform/test/') !== FALSE) {
      $this->type = 'webform_test';
    }
    elseif (strpos($path, 'admin/structure/webform/options/') !== FALSE) {
      $this->type = 'webform_options';
    }
    elseif (strpos($path, 'admin/structure/webform/config/') !== FALSE) {
      $this->type = 'webform_config';
    }
    else {
      $this->type = NULL;
    }
    return $this->type ? TRUE : FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function build(RouteMatchInterface $route_match) {
    $route_name = $route_match
      ->getRouteName();
    if ($this->type === 'webform_source_entity') {
      $source_entity = $this->requestHandler
        ->getCurrentSourceEntity([
        'webform',
        'webform_submission',
      ]);
      $entity_type = $source_entity
        ->getEntityTypeId();
      $entity_id = $source_entity
        ->id();
      $breadcrumb = new Breadcrumb();
      $breadcrumb
        ->addLink(Link::createFromRoute($this
        ->t('Home'), '<front>'));
      $breadcrumb
        ->addLink($source_entity
        ->toLink());
      if ($webform_submission = $route_match
        ->getParameter('webform_submission')) {
        if (strpos($route_match
          ->getRouteName(), 'webform.user.submission') !== FALSE) {
          $breadcrumb
            ->addLink(Link::createFromRoute($this
            ->t('Submissions'), "entity.{$entity_type}.webform.user.submissions", [
            $entity_type => $entity_id,
          ]));
        }
        elseif ($source_entity
          ->access('webform_submission_view') || $webform_submission
          ->access('view_any')) {
          $breadcrumb
            ->addLink(Link::createFromRoute($this
            ->t('Results'), "entity.{$entity_type}.webform.results_submissions", [
            $entity_type => $entity_id,
          ]));
        }
        elseif ($webform_submission
          ->access('view_own')) {
          $breadcrumb
            ->addLink(Link::createFromRoute($this
            ->t('Results'), "entity.{$entity_type}.webform.user.submissions", [
            $entity_type => $entity_id,
          ]));
        }
      }
    }
    elseif ($this->type === 'webform_help') {
      $breadcrumb = new Breadcrumb();
      $breadcrumb
        ->addLink(Link::createFromRoute($this
        ->t('Home'), '<front>'));
      $breadcrumb
        ->addLink(Link::createFromRoute($this
        ->t('Administration'), 'system.admin'));
      $breadcrumb
        ->addLink(Link::createFromRoute($this
        ->t('Help'), 'help.main'));
      $breadcrumb
        ->addLink(Link::createFromRoute($this
        ->t('Webform'), 'help.page', [
        'name' => 'webform',
      ]));
    }
    elseif ($this->type === 'webform_plugins_elements') {
      $breadcrumb = new Breadcrumb();
      $breadcrumb
        ->addLink(Link::createFromRoute($this
        ->t('Home'), '<front>'));
      $breadcrumb
        ->addLink(Link::createFromRoute($this
        ->t('Administration'), 'system.admin'));
      $breadcrumb
        ->addLink(Link::createFromRoute($this
        ->t('Reports'), 'system.admin_reports'));
      $breadcrumb
        ->addLink(Link::createFromRoute($this
        ->t('Elements'), 'webform.reports_plugins.elements'));
    }
    else {
      $breadcrumb = new Breadcrumb();
      $breadcrumb
        ->addLink(Link::createFromRoute($this
        ->t('Home'), '<front>'));
      $breadcrumb
        ->addLink(Link::createFromRoute($this
        ->t('Administration'), 'system.admin'));
      if (!$this->configFactory
        ->get('webform.settings')
        ->get('ui.toolbar_item')) {
        $breadcrumb
          ->addLink(Link::createFromRoute($this
          ->t('Structure'), 'system.admin_structure'));
      }
      $breadcrumb
        ->addLink(Link::createFromRoute($this
        ->t('Webforms'), 'entity.webform.collection'));
      switch ($this->type) {
        case 'webform_config':
          $breadcrumb
            ->addLink(Link::createFromRoute($this
            ->t('Configuration'), 'webform.config'));
          if (strpos($route_name, 'config_translation.item.') === 0 && $route_name !== 'config_translation.item.overview.webform.config') {
            $breadcrumb
              ->addLink(Link::createFromRoute($this
              ->t('Translate'), 'config_translation.item.overview.webform.config'));
          }
          break;
        case 'webform_options':
          if ($route_name !== 'entity.webform_options.collection') {
            $breadcrumb
              ->addLink(Link::createFromRoute($this
              ->t('Options'), 'entity.webform_options.collection'));
          }
          if (strpos($route_name, 'entity.webform_image_select_images') === 0) {

            // @see webform_image_select.module.
            if ($route_name !== 'entity.webform_image_select_images.collection') {
              $breadcrumb
                ->addLink(Link::createFromRoute($this
                ->t('Images'), 'entity.webform_image_select_images.collection'));
            }
          }
          elseif (strpos($route_name, 'entity.webform_options_custom') === 0) {

            // @see webform_custom_options.module.
            if ($route_name !== 'entity.webform_options_custom.collection') {
              $breadcrumb
                ->addLink(Link::createFromRoute($this
                ->t('Custom'), 'entity.webform_options_custom.collection'));
            }
          }
          break;
        case 'webform_test':
          $breadcrumb
            ->addLink(Link::createFromRoute($this
            ->t('Testing'), 'webform_test.index'));
          break;
        case 'webform_template':
          $breadcrumb
            ->addLink(Link::createFromRoute($this
            ->t('Templates'), 'entity.webform.templates'));
          break;
        case 'webform_element':

          /** @var \Drupal\webform\WebformInterface $webform */
          $webform = $route_match
            ->getParameter('webform');
          $breadcrumb
            ->addLink(Link::createFromRoute($webform
            ->label(), 'entity.webform.canonical', [
            'webform' => $webform
              ->id(),
          ]));
          $breadcrumb
            ->addLink(Link::createFromRoute($this
            ->t('Elements'), 'entity.webform.edit_form', [
            'webform' => $webform
              ->id(),
          ]));
          break;
        case 'webform_handler':

          /** @var \Drupal\webform\WebformInterface $webform */
          $webform = $route_match
            ->getParameter('webform');
          $breadcrumb
            ->addLink(Link::createFromRoute($webform
            ->label(), 'entity.webform.canonical', [
            'webform' => $webform
              ->id(),
          ]));
          $breadcrumb
            ->addLink(Link::createFromRoute($this
            ->t('Emails / Handlers'), 'entity.webform.handlers', [
            'webform' => $webform
              ->id(),
          ]));
          break;
        case 'webform_variant':

          /** @var \Drupal\webform\WebformInterface $webform */
          $webform = $route_match
            ->getParameter('webform');
          $breadcrumb
            ->addLink(Link::createFromRoute($webform
            ->label(), 'entity.webform.canonical', [
            'webform' => $webform
              ->id(),
          ]));
          $breadcrumb
            ->addLink(Link::createFromRoute($this
            ->t('Variants'), 'entity.webform.variants', [
            'webform' => $webform
              ->id(),
          ]));
          break;
        case 'webform_submission':

          /** @var \Drupal\webform\WebformSubmissionInterface $webform_submission */
          $webform_submission = $route_match
            ->getParameter('webform_submission');
          $webform = $webform_submission
            ->getWebform();
          $breadcrumb
            ->addLink(Link::createFromRoute($webform
            ->label(), 'entity.webform.canonical', [
            'webform' => $webform
              ->id(),
          ]));
          $breadcrumb
            ->addLink(Link::createFromRoute($this
            ->t('Results'), 'entity.webform.results_submissions', [
            'webform' => $webform
              ->id(),
          ]));
          break;
        case 'webform_user_submissions':
        case 'webform_user_drafts':

          /** @var \Drupal\webform\WebformInterface $webform */
          $webform = $route_match
            ->getParameter('webform');
          $breadcrumb = new Breadcrumb();
          $breadcrumb
            ->addLink(Link::createFromRoute($webform
            ->label(), 'entity.webform.canonical', [
            'webform' => $webform
              ->id(),
          ]));
          break;
        case 'webform_user_submission':

          /** @var \Drupal\webform\WebformSubmissionInterface $webform_submission */
          $webform_submission = $route_match
            ->getParameter('webform_submission');
          $webform = $webform_submission
            ->getWebform();
          $breadcrumb = new Breadcrumb();
          $breadcrumb
            ->addLink(Link::createFromRoute($webform
            ->label(), 'entity.webform.canonical', [
            'webform' => $webform
              ->id(),
          ]));
          if ($webform_submission
            ->access('view_own')) {
            $breadcrumb
              ->addLink(Link::createFromRoute($this
              ->t('Submissions'), 'entity.webform.user.submissions', [
              'webform' => $webform
                ->id(),
            ]));
          }
          break;
      }
    }

    // This breadcrumb builder is based on a route parameter, and hence it
    // depends on the 'route' cache context.
    $breadcrumb
      ->addCacheContexts([
      'route',
    ]);
    return $breadcrumb;
  }

  /**
   * Get the type of webform breadcrumb.
   *
   * @return string
   *   The type of webform breadcrumb.
   */
  public function getType() {
    return $this->type;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.
WebformBreadcrumbBuilder::$configFactory	protected	property	The configuration object factory.
WebformBreadcrumbBuilder::$moduleHandler	protected	property	The module handler service.
WebformBreadcrumbBuilder::$requestHandler	protected	property	The webform request handler.
WebformBreadcrumbBuilder::$type	protected	property	The current route's entity or plugin type.
WebformBreadcrumbBuilder::applies	public	function	Whether this breadcrumb builder should be used to build the breadcrumb. Overrides BreadcrumbBuilderInterface::applies
WebformBreadcrumbBuilder::build	public	function	Builds the breadcrumb. Overrides BreadcrumbBuilderInterface::build
WebformBreadcrumbBuilder::getType	public	function	Get the type of webform breadcrumb.
WebformBreadcrumbBuilder::__construct	public	function	Constructs a WebformBreadcrumbBuilder object.