You are here

Home » API reference » Paragraphs Editor Enhancements 8 » ParagraphsOffCanvasBrowser.php

class ParagraphsOffCanvasBrowser in Paragraphs Editor Enhancements 8

Controller for the Paragraphs off-canvas browser.

Hierarchy

Expanded class hierarchy of ParagraphsOffCanvasBrowser

File

src/Controller/ParagraphsOffCanvasBrowser.php, line 10

Namespace

Drupal\paragraphs_ee\Controller
View source 
class ParagraphsOffCanvasBrowser extends ControllerBase {

  /**
   * Generate the title for the off-canvas browser page.
   */
  public function getTitle($entity_type, $bundle, $form_mode, $field_name) {
    $title_default = $this
      ->t('Add Paragraph', [], [
      'context' => 'Paragraphs Editor Enhancements',
    ]);

    /** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $form_display */
    $form_display = $this
      ->entityTypeManager()
      ->getStorage('entity_form_display')
      ->load($entity_type . '.' . $bundle . '.' . $form_mode);
    if (!$form_display) {
      return $title_default;
    }
    $component = $form_display
      ->getComponent($field_name);
    if (!$component || !isset($component['third_party_settings']['paragraphs_ee']['paragraphs_ee']['dialog_off_canvas']) || TRUE !== $component['third_party_settings']['paragraphs_ee']['paragraphs_ee']['dialog_off_canvas']) {
      return $title_default;
    }
    return $this
      ->t('Add @widget_title', [
      '@widget_title' => $component['settings']['title'],
    ], [
      'context' => 'Paragraphs Editor Enhancements',
    ]);
  }

  /**
   * Build render array for the off-canvas browser page.
   */
  public function content($entity_type, $bundle, $form_mode, $field_name) {
    $build = [];

    /** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $form_display */
    $form_display = $this
      ->entityTypeManager()
      ->getStorage('entity_form_display')
      ->load($entity_type . '.' . $bundle . '.' . $form_mode);
    if (!$form_display) {
      return $build;
    }
    $component = $form_display
      ->getComponent($field_name);
    if (!$component || !isset($component['third_party_settings']['paragraphs_ee']['paragraphs_ee']['dialog_off_canvas']) || TRUE !== $component['third_party_settings']['paragraphs_ee']['paragraphs_ee']['dialog_off_canvas']) {
      return $build;
    }
    $build['dialog'] = [
      '#theme' => 'paragraphs_add_dialog__categorized',
      '#add' => NULL,
      '#attributes' => [
        'role' => 'dialog',
        'aria-modal' => 'false',
        'aria-label' => $this
          ->t('Add @widget_title', [
          '@widget_title' => $component['settings']['title'],
        ], [
          'context' => 'Paragraphs Editor Enhancements',
        ]),
        'data-field-name' => $field_name,
        'data-widget-title' => $component['settings']['title'],
        'data-widget-title-plural' => $component['settings']['title_plural'],
        'class' => [
          'paragraphs-add-dialog',
          'paragraphs-add-dialog--categorized',
          'js-hide',
        ],
      ],
      '#groups' => [],
      '#add_mode' => 'off_canvas',
    ];
    $build['#attached']['library'][] = 'paragraphs_ee/paragraphs_ee.off_canvas';
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 40
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
ParagraphsOffCanvasBrowser::content public function Build render array for the off-canvas browser page.
ParagraphsOffCanvasBrowser::getTitle public function Generate the title for the off-canvas browser page.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.