You are here

Home » API reference » YAML Form 8 » YamlFormPluginHandlerController.php

class YamlFormPluginHandlerController in YAML Form 8

Controller for all form handlers.

Hierarchy

Expanded class hierarchy of YamlFormPluginHandlerController

File

src/Controller/YamlFormPluginHandlerController.php, line 18

Namespace

Drupal\yamlform\Controller
View source 
class YamlFormPluginHandlerController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * A form handler plugin manager.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $pluginManager;

  /**
   * Constructs a YamlFormPluginBaseController object.
   *
   * @param \Drupal\Component\Plugin\PluginManagerInterface $plugin_manager
   *   A form handler plugin manager.
   */
  public function __construct(PluginManagerInterface $plugin_manager) {
    $this->pluginManager = $plugin_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.yamlform.handler'));
  }

  /**
   * {@inheritdoc}
   */
  public function index() {
    $definitions = $this->pluginManager
      ->getDefinitions();
    $definitions = $this->pluginManager
      ->getSortedDefinitions($definitions);
    $rows = [];
    foreach ($definitions as $plugin_id => $definition) {
      $rows[$plugin_id] = [
        $plugin_id,
        $definition['label'],
        $definition['description'],
        $definition['category'],
        $definition['cardinality'] == -1 ? $this
          ->t('Unlimited') : $definition['cardinality'],
        $definition['results'] ? $this
          ->t('Processed') : $this
          ->t('Ignored'),
        $definition['provider'],
      ];
    }
    ksort($rows);
    return [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('ID'),
        $this
          ->t('Label'),
        $this
          ->t('Description'),
        $this
          ->t('Category'),
        $this
          ->t('Cardinality'),
        $this
          ->t('Results'),
        $this
          ->t('Provided by'),
      ],
      '#rows' => $rows,
      '#sticky' => TRUE,
    ];
  }

  /**
   * Shows a list of form handlers that can be added to a form.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param \Drupal\yamlform\YamlFormInterface $yamlform
   *   A form.
   *
   * @return array
   *   A render array as expected by the renderer.
   */
  public function listHandlers(Request $request, YamlFormInterface $yamlform) {
    $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);
    $rows = [];
    foreach ($definitions as $plugin_id => $definition) {

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

      // Check cardinality.
      $cardinality = $definition['cardinality'];
      $is_cardinality_unlimited = $cardinality == YamlFormHandlerInterface::CARDINALITY_UNLIMITED;
      $is_cardinality_reached = $yamlform
        ->getHandlers($plugin_id)
        ->count() >= $cardinality;
      if (!$is_cardinality_unlimited && $is_cardinality_reached) {
        continue;
      }
      $row = [];
      $row['title']['data'] = [
        '#type' => 'inline_template',
        '#template' => '<div class="yamlform-form-filter-text-source">{{ label }}</div>',
        '#context' => [
          'label' => $definition['label'],
        ],
      ];
      $row['description'] = [
        'data' => [
          '#markup' => $definition['description'],
        ],
      ];
      $row['category'] = $definition['category'];
      $links['add'] = [
        'title' => $this
          ->t('Add handler'),
        'url' => Url::fromRoute('entity.yamlform.handler.add_form', [
          'yamlform' => $yamlform
            ->id(),
          'yamlform_handler' => $plugin_id,
        ]),
        'attributes' => YamlFormDialogHelper::getModalDialogAttributes(800),
      ];
      $row['operations']['data'] = [
        '#type' => 'operations',
        '#links' => $links,
      ];
      $rows[] = $row;
    }
    $build['#attached']['library'][] = 'yamlform/yamlform.form';
    $build['filter'] = [
      '#type' => 'search',
      '#title' => $this
        ->t('Filter'),
      '#title_display' => 'invisible',
      '#size' => 30,
      '#placeholder' => $this
        ->t('Filter by handler name'),
      '#attributes' => [
        'class' => [
          'yamlform-form-filter-text',
        ],
        'data-element' => '.yamlform-handler-add-table',
        'title' => $this
          ->t('Enter a part of the handler name to filter by.'),
        'autofocus' => 'autofocus',
      ],
    ];
    $build['handlers'] = [
      '#type' => 'table',
      '#header' => $headers,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No handler available.'),
      '#attributes' => [
        'class' => [
          'yamlform-handler-add-table',
        ],
      ],
    ];
    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::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.
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.
YamlFormPluginHandlerController::$pluginManager protected property A form handler plugin manager.
YamlFormPluginHandlerController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
YamlFormPluginHandlerController::index public function
YamlFormPluginHandlerController::listHandlers public function Shows a list of form handlers that can be added to a form.
YamlFormPluginHandlerController::__construct public function Constructs a YamlFormPluginBaseController object.