class WebformHandlerAddForm in Webform 6.x

Provides an add form for webform handler.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\webform\Form\WebformHandlerFormBase uses WebformDialogFormTrait
    • class \Drupal\webform\Form\WebformHandlerAddForm

1 string reference to 'WebformHandlerAddForm'

webform.routing.yml in ./webform.routing.yml

webform.routing.yml

File

src/Form/WebformHandlerAddForm.php, line 13

Namespace

Drupal\webform\Form

class WebformHandlerAddForm extends WebformHandlerFormBase {

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

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

  /**
   * {@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

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
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.	3
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.
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.
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.
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
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::getWebform	public	function	Get the webform handler's webform.
WebformHandlerFormBase::getWebformHandler	public	function	Get the webform handler.
WebformHandlerFormBase::MACHINE_NAME_MAXLENGTH		constant	Machine name maxlength.
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
WebformHandlerFormBase::validateMachineName	public	function	Validates the machine name for a webform handler instance.