You are here

class WebformHandlerAddForm in Webform 8.5

Same name and namespace in other branches
  1. 6.x src/Form/WebformHandlerAddForm.php \Drupal\webform\Form\WebformHandlerAddForm

Provides an add form for webform handler.

Hierarchy

Expanded class hierarchy of WebformHandlerAddForm

1 string reference to 'WebformHandlerAddForm'
webform.routing.yml in ./webform.routing.yml
webform.routing.yml

File

src/Form/WebformHandlerAddForm.php, line 17

Namespace

Drupal\webform\Form
View source
class WebformHandlerAddForm extends WebformHandlerFormBase {

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

  /**
   * Constructs a WebformHandlerAddForm.
   *
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\Component\Transliteration\TransliterationInterface $transliteration
   *   The transliteration helper.
   * @param \Drupal\webform\WebformTokenManagerInterface $token_manager
   *   The webform token manager.
   * @param \Drupal\webform\Plugin\WebformHandlerManagerInterface $webform_handler
   *   The webform handler manager.
   */
  public function __construct(LanguageManagerInterface $language_manager, TransliterationInterface $transliteration, WebformTokenManagerInterface $token_manager, WebformHandlerManagerInterface $webform_handler) {
    parent::__construct($language_manager, $transliteration, $token_manager);
    $this->webformHandlerManager = $webform_handler;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, WebformInterface $webform = NULL, $webform_handler = NULL) {
    $form = parent::buildForm($form, $form_state, $webform, $webform_handler);

    // Throw access denied is handler is excluded.
    if ($this->webformHandler
      ->isExcluded()) {
      throw new AccessDeniedHttpException();
    }
    $form['#title'] = $this
      ->t('Add @label handler', [
      '@label' => $this->webformHandler
        ->label(),
    ]);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  protected function prepareWebformHandler($webform_handler) {

    /** @var \Drupal\webform\Plugin\WebformHandlerInterface $webform_handler */
    $webform_handler = $this->webformHandlerManager
      ->createInstance($webform_handler);

    // Initialize the handler an pass in the webform.
    $webform_handler
      ->setWebform($this->webform);

    // Set the initial weight so this handler comes last.
    $handlers = $this->webform
      ->getHandlers();
    $weight = 0;
    foreach ($handlers as $handler) {
      if ($weight < $handler
        ->getWeight()) {
        $weight = $handler
          ->getWeight() + 1;
      }
    }
    $webform_handler
      ->setWeight($weight);
    return $webform_handler;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
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.
WebformAjaxFormTrait::announce protected function Queue announcement with Ajax response.
WebformAjaxFormTrait::buildAjaxForm protected function Add Ajax support to a form.
WebformAjaxFormTrait::createAjaxResponse protected function Create an AjaxResponse or WebformAjaxResponse object.
WebformAjaxFormTrait::getAnnouncements protected function Get announcements.
WebformAjaxFormTrait::getDefaultAjaxSettings protected function Get default ajax callback settings. 1
WebformAjaxFormTrait::getFormStateRedirectUrl protected function Get redirect URL from the form's state.
WebformAjaxFormTrait::getWrapperId protected function Get the form's Ajax wrapper id. 1
WebformAjaxFormTrait::isCallableAjaxCallback protected function Determine if Ajax callback is callable.
WebformAjaxFormTrait::isDialog protected function Is the current request for an Ajax modal/dialog.
WebformAjaxFormTrait::isOffCanvasDialog protected function Is the current request for an off canvas dialog.
WebformAjaxFormTrait::missingAjaxCallback protected function Handle missing Ajax callback.
WebformAjaxFormTrait::replaceForm protected function Replace form via an Ajax response. 1
WebformAjaxFormTrait::resetAnnouncements protected function Reset announcements.
WebformAjaxFormTrait::setAnnouncements protected function Set announcements.
WebformAjaxFormTrait::submitAjaxForm public function Submit form #ajax callback. 1
WebformAjaxFormTrait::validateAjaxForm public function Validate form #ajax callback. 1
WebformDialogFormTrait::buildDialogConfirmForm protected function Add modal dialog support to a confirm form.
WebformDialogFormTrait::buildDialogDeleteAction protected function Build webform dialog delete link.
WebformDialogFormTrait::buildDialogForm protected function Add modal dialog support to a form.
WebformDialogFormTrait::cancelAjaxForm public function Cancel form #ajax callback. Overrides WebformAjaxFormTrait::cancelAjaxForm 1
WebformDialogFormTrait::closeDialog public function Close dialog.
WebformDialogFormTrait::isAjax protected function Returns if webform is using Ajax. Overrides WebformAjaxFormTrait::isAjax 1
WebformDialogFormTrait::noSubmit public function Empty submit callback used to only have the submit button to use an #ajax submit callback. Overrides WebformAjaxFormTrait::noSubmit
WebformDialogFormTrait::noValidate public function Validate callback to clear validation errors. 2
WebformHandlerAddForm::$webformHandlerManager protected property The webform handler manager.
WebformHandlerAddForm::buildForm public function Form constructor. Overrides WebformHandlerFormBase::buildForm 1
WebformHandlerAddForm::create public static function Instantiates a new instance of this class. Overrides WebformHandlerFormBase::create
WebformHandlerAddForm::prepareWebformHandler protected function 1
WebformHandlerAddForm::__construct public function Constructs a WebformHandlerAddForm. Overrides WebformHandlerFormBase::__construct
WebformHandlerFormBase::$languageManager protected property The language manager.
WebformHandlerFormBase::$tokenManager protected property The token manager.
WebformHandlerFormBase::$transliteration protected property The transliteration helper.
WebformHandlerFormBase::$webform protected property The webform.
WebformHandlerFormBase::$webformHandler protected property The webform handler.
WebformHandlerFormBase::exists public function Determines if the webform handler ID already exists.
WebformHandlerFormBase::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
WebformHandlerFormBase::getUniqueMachineName public function Generates a unique translated machine name for a webform handler instance.
WebformHandlerFormBase::getWebform public function Get the webform handler's webform.
WebformHandlerFormBase::getWebformHandler public function Get the webform handler.
WebformHandlerFormBase::MACHINE_NAME_MAXLENGHTH constant Machine name maxlenght.
WebformHandlerFormBase::processHandlerFormErrors protected function Process handler webform errors in webform.
WebformHandlerFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm
WebformHandlerFormBase::validateForm public function Form validation handler. Overrides FormBase::validateForm