You are here

Home » API reference » Webform 6.x » WebformPluginHandlerController.php

class WebformPluginHandlerController in Webform 6.x

Same name and namespace in other branches
  1. 8.5 src/Controller/WebformPluginHandlerController.php \Drupal\webform\Controller\WebformPluginHandlerController

Controller for all webform handlers.

Hierarchy

Expanded class hierarchy of WebformPluginHandlerController

File

src/Controller/WebformPluginHandlerController.php, line 18

Namespace

Drupal\webform\Controller
View source 
class WebformPluginHandlerController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * The webform handler plugin manager.
   *
   * @var \Drupal\webform\Plugin\WebformHandlerManagerInterface
   */
  protected $pluginManager;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->pluginManager = $container
      ->get('plugin.manager.webform.handler');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function index() {
    $excluded_handlers = $this
      ->config('webform.settings')
      ->get('handler.excluded_handlers');
    $used_by = [];

    /** @var \Drupal\webform\WebformInterface[] $webforms */
    $webforms = Webform::loadMultiple();
    foreach ($webforms as $webform) {
      $handlers = $webform
        ->getHandlers();
      foreach ($handlers as $handler) {
        $used_by[$handler
          ->getPluginId()][$webform
          ->id()] = $webform
          ->toLink()
          ->toRenderable();
      }
    }
    $definitions = $this->pluginManager
      ->getDefinitions();
    $definitions = $this->pluginManager
      ->getSortedDefinitions($definitions);
    $rows = [];
    foreach ($definitions as $plugin_id => $definition) {
      $row = [];
      $row[] = $plugin_id;
      $row[] = [
        'data' => [
          '#markup' => $definition['label'],
          '#prefix' => '<span class="webform-form-filter-text-source">',
          '#suffix' => '</span>',
        ],
      ];
      $row[] = $definition['description'];
      $row[] = $definition['category'];
      $row[] = isset($excluded_handlers[$plugin_id]) ? $this
        ->t('Yes') : $this
        ->t('No');
      $row[] = $definition['cardinality'] === -1 ? $this
        ->t('Unlimited') : $definition['cardinality'];
      $row[] = $definition['conditions'] ? $this
        ->t('Yes') : $this
        ->t('No');
      $row[] = $definition['submission'] ? $this
        ->t('Required') : $this
        ->t('Optional');
      $row[] = $definition['results'] ? $this
        ->t('Processed') : $this
        ->t('Ignored');
      $row[] = isset($used_by[$plugin_id]) ? [
        'data' => [
          '#theme' => 'item_list',
          '#items' => $used_by[$plugin_id],
        ],
      ] : '';
      $row[] = $definition['provider'];
      $rows[$plugin_id] = [
        'data' => $row,
      ];
      if (isset($excluded_handlers[$plugin_id])) {
        $rows[$plugin_id]['class'] = [
          'color-warning',
        ];
      }
    }
    ksort($rows);
    $build = [];

    // Filter.
    $build['filter'] = [
      '#type' => 'search',
      '#title' => $this
        ->t('Filter'),
      '#title_display' => 'invisible',
      '#size' => 30,
      '#placeholder' => $this
        ->t('Filter by handler label'),
      '#attributes' => [
        'class' => [
          'webform-form-filter-text',
        ],
        'data-element' => '.webform-handler-plugin-table',
        'data-summary' => '.webform-handler-plugin-summary',
        'data-item-singlular' => $this
          ->t('handler'),
        'data-item-plural' => $this
          ->t('handlers'),
        'title' => $this
          ->t('Enter a part of the handler label to filter by.'),
        'autofocus' => 'autofocus',
      ],
    ];

    // Settings.
    $build['settings'] = [
      '#type' => 'link',
      '#title' => $this
        ->t('Edit configuration'),
      '#url' => Url::fromRoute('webform.config.handlers'),
      '#attributes' => [
        'class' => [
          'button',
          'button--small',
        ],
        'style' => 'float: right',
      ],
    ];

    // Display info.
    $build['info'] = [
      '#markup' => $this
        ->t('@total handlers', [
        '@total' => count($rows),
      ]),
      '#prefix' => '<p class="webform-handler-plugin-summary">',
      '#suffix' => '</p>',
    ];

    // Handlers.
    $build['webform_handlers'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('ID'),
        $this
          ->t('Label'),
        $this
          ->t('Description'),
        $this
          ->t('Category'),
        $this
          ->t('Excluded'),
        $this
          ->t('Cardinality'),
        $this
          ->t('Conditional'),
        $this
          ->t('Database'),
        $this
          ->t('Results'),
        $this
          ->t('Used by'),
        $this
          ->t('Provided by'),
      ],
      '#rows' => $rows,
      '#sticky' => TRUE,
      '#attributes' => [
        'class' => [
          'webform-handler-plugin-table',
        ],
      ],
    ];
    $build['#attached']['library'][] = 'webform/webform.admin';
    return $build;
  }

  /**
   * Shows a list of webform handlers that can be added to a webform.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param \Drupal\webform\WebformInterface $webform
   *   A webform.
   *
   * @return array
   *   A render array as expected by the renderer.
   */
  public function listHandlers(Request $request, WebformInterface $webform) {
    $headers = [
      [
        'data' => $this
          ->t('Handler'),
        'width' => '20%',
      ],
      [
        'data' => $this
          ->t('Description'),
        'width' => '40%',
      ],
      [
        'data' => $this
          ->t('Category'),
        'width' => '20%',
      ],
      [
        'data' => $this
          ->t('Operations'),
        'width' => '20%',
      ],
    ];
    $definitions = $this->pluginManager
      ->getDefinitions();
    $definitions = $this->pluginManager
      ->getSortedDefinitions($definitions);
    $definitions = $this->pluginManager
      ->removeExcludeDefinitions($definitions);
    $rows = [];
    foreach ($definitions as $plugin_id => $definition) {

      // Skip email handler which has dedicated button.
      if ($plugin_id === 'email') {
        continue;
      }

      /** @var \Drupal\webform\Plugin\WebformHandlerInterface $handler_plugin */
      $handler_plugin = $this->pluginManager
        ->createInstance($plugin_id);

      // Check if applicable.
      if (!$handler_plugin
        ->isApplicable($webform)) {
        continue;
      }

      // Check cardinality.
      $cardinality = $definition['cardinality'];
      $is_cardinality_unlimited = $cardinality === WebformHandlerInterface::CARDINALITY_UNLIMITED;
      $is_cardinality_reached = $webform
        ->getHandlers($plugin_id)
        ->count() >= $cardinality;
      if (!$is_cardinality_unlimited && $is_cardinality_reached) {
        continue;
      }
      $is_submission_required = $definition['submission'] === WebformHandlerInterface::SUBMISSION_REQUIRED;
      $is_results_disabled = $webform
        ->getSetting('results_disabled');
      $row = [];
      if ($is_submission_required && $is_results_disabled) {
        $row['title']['data'] = [
          '#markup' => $definition['label'],
          '#prefix' => '<div class="webform-form-filter-text-source">',
          '#suffix' => '</div>',
        ];
      }
      else {
        $row['title']['data'] = [
          '#type' => 'link',
          '#title' => $definition['label'],
          '#url' => Url::fromRoute('entity.webform.handler.add_form', [
            'webform' => $webform
              ->id(),
            'webform_handler' => $plugin_id,
          ]),
          '#attributes' => WebformDialogHelper::getOffCanvasDialogAttributes($handler_plugin
            ->getOffCanvasWidth()),
          '#prefix' => '<div class="webform-form-filter-text-source">',
          '#suffix' => '</div>',
        ];
      }
      $row['description'] = [
        'data' => [
          '#markup' => $definition['description'],
        ],
      ];
      $row['category'] = $definition['category'];

      // Check submission required.
      if ($is_submission_required && $is_results_disabled) {
        $row['operations']['data'] = [
          '#type' => 'html_tag',
          '#tag' => 'span',
          '#value' => $this
            ->t('Requires saving of submissions.'),
          '#attributes' => [
            'class' => [
              'color-warning',
            ],
          ],
        ];
      }
      else {
        $links['add'] = [
          'title' => $this
            ->t('Add handler'),
          'url' => Url::fromRoute('entity.webform.handler.add_form', [
            'webform' => $webform
              ->id(),
            'webform_handler' => $plugin_id,
          ]),
          'attributes' => WebformDialogHelper::getOffCanvasDialogAttributes($handler_plugin
            ->getOffCanvasWidth()),
        ];
        $row['operations']['data'] = [
          '#type' => 'operations',
          '#links' => $links,
          '#prefix' => '<div class="webform-dropbutton">',
          '#suffix' => '</div>',
        ];
      }
      $rows[] = $row;
    }
    $build['filter'] = [
      '#type' => 'search',
      '#title' => $this
        ->t('Filter'),
      '#title_display' => 'invisible',
      '#size' => 30,
      '#placeholder' => $this
        ->t('Filter by handler name'),
      '#attributes' => [
        'class' => [
          'webform-form-filter-text',
        ],
        'data-element' => '.webform-handler-add-table',
        'data-item-singlular' => $this
          ->t('handler'),
        'data-item-plural' => $this
          ->t('handlers'),
        'title' => $this
          ->t('Enter a part of the handler name to filter by.'),
        'autofocus' => 'autofocus',
      ],
    ];
    $build['handlers'] = [
      '#type' => 'table',
      '#header' => $headers,
      '#rows' => $rows,
      '#sticky' => TRUE,
      '#empty' => $this
        ->t('No handler available.'),
      '#attributes' => [
        'class' => [
          'webform-handler-add-table',
        ],
      ],
    ];
    $build['#attached']['library'][] = 'webform/webform.admin';
    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::$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::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
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.
ControllerBase::state protected function Returns the state storage 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. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
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. 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.
WebformPluginHandlerController::$pluginManager protected property The webform handler plugin manager.
WebformPluginHandlerController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
WebformPluginHandlerController::index public function
WebformPluginHandlerController::listHandlers public function Shows a list of webform handlers that can be added to a webform.