You are here

Home » API reference » Webhooks 8 » WebhookConfigForm.php

class WebhookConfigForm in Webhooks 8

Class Webhook Config Form.

@package Drupal\webhooks\Form

Hierarchy

Expanded class hierarchy of WebhookConfigForm

File

src/Form/WebhookConfigForm.php, line 18

Namespace

Drupal\webhooks\Form
View source 
class WebhookConfigForm extends EntityForm {

  /**
   * Webhook service.
   *
   * @var \Drupal\webhooks\WebhooksService
   */
  protected $webhookService;

  /**
   * Module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The events.
   *
   * @var array
   */
  protected $events = [];

  /**
   * The entity hooks.
   *
   * @var string[]
   */
  protected $entityHooks = [
    'create',
    'update',
    'delete',
  ];

  /**
   * The system hooks.
   *
   * @var string[]
   */
  protected $systemHooks = [
    'cron',
    'file_download',
    'modules_installed',
    'user_cancel',
    'user_login',
    'user_logout',
    'cache_flush',
  ];

  /**
   * Webhook Config Form constructor.
   *
   * @param \Drupal\webhooks\WebhooksService $webhookService
   *   The webhook service.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   The module handler service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager.
   */
  public function __construct(WebhooksService $webhookService, ModuleHandlerInterface $moduleHandler, EntityTypeManagerInterface $entityTypeManager) {
    $this->webhookService = $webhookService;
    $this->moduleHandler = $moduleHandler;
    $this->entityTypeManager = $entityTypeManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('webhooks.service'), $container
      ->get('module_handler'), $container
      ->get('entity_type.manager'));
  }

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

    /** @var \Drupal\webhooks\Entity\WebhookConfig $webhook_config */
    $webhook_config = $this->entity;
    $form['label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Label'),
      '#maxlength' => 255,
      '#default_value' => $webhook_config
        ->label(),
      '#description' => $this
        ->t('Easily recognizable name for your webhook.'),
      '#required' => TRUE,
    ];
    $form['id'] = [
      '#type' => 'machine_name',
      '#default_value' => $webhook_config
        ->id(),
      '#machine_name' => [
        'exists' => '\\Drupal\\webhooks\\Entity\\WebhookConfig::load',
      ],
      '#disabled' => !$webhook_config
        ->isNew(),
    ];
    $form['type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Type'),
      '#options' => [
        'incoming' => $this
          ->t('Incoming'),
        'outgoing' => $this
          ->t('Outgoing'),
      ],
      '#default_value' => $webhook_config
        ->getType() ? $webhook_config
        ->getType() : 'outgoing',
      '#description' => $this
        ->t('The type of webhook. <strong>Incoming webhooks</strong> receive HTTP events. <strong>Outgoing webhooks</strong> post new events to the configured URL.'),
      '#required' => TRUE,
      '#disabled' => !$webhook_config
        ->isNew(),
    ];
    $form['content_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t("Content Type"),
      '#description' => $this
        ->t("The Content Type of your webhook."),
      '#options' => [
        WebhookConfig::CONTENT_TYPE_JSON => $this
          ->t('application/json'),
        WebhookConfig::CONTENT_TYPE_XML => $this
          ->t('application/xml'),
      ],
      '#default_value' => $webhook_config
        ->getContentType(),
    ];
    $form['secret'] = [
      '#type' => 'textfield',
      '#attributes' => [
        'placeholder' => $this
          ->t('Secret'),
      ],
      '#title' => $this
        ->t('Secret'),
      '#maxlength' => 255,
      '#description' => $this
        ->t('For <strong>incoming webhooks</strong> this secret is provided by the remote website. For <strong>outgoing webhooks</strong> this secret should be used for the incoming hook configuration on the remote website.'),
      '#default_value' => $webhook_config
        ->getSecret(),
    ];
    $form['token'] = [
      '#type' => 'textfield',
      '#attributes' => [
        'placeholder' => $this
          ->t('Token'),
      ],
      '#title' => $this
        ->t('Token'),
      '#maxlength' => 255,
      '#description' => $this
        ->t('For <strong>incoming webhooks</strong> this secret is provided by the remote website. For <strong>outgoing webhooks</strong> this secret should be used for the incoming hook configuration on the remote website.'),
      '#default_value' => $webhook_config
        ->getToken(),
    ];
    $form['incoming'] = [
      '#title' => $this
        ->t('Incoming Webhook Settings'),
      '#type' => 'details',
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#states' => [
        'expanded' => [
          ':input[name="type"]' => [
            'value' => 'incoming',
          ],
        ],
        'enabled' => [
          ':input[name="type"]' => [
            'value' => 'incoming',
          ],
        ],
        'required' => [
          ':input[name="type"]' => [
            'value' => 'incoming',
          ],
        ],
        'collapsed' => [
          ':input[name="type"]' => [
            'value' => 'outgoing',
          ],
        ],
        'disabled' => [
          ':input[name="type"]' => [
            'value' => 'outgoing',
          ],
        ],
        'optional' => [
          ':input[name="type"]' => [
            'value' => 'outgoing',
          ],
        ],
      ],
    ];
    $form['incoming']['non_blocking'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Non-blocking'),
      '#default_value' => $webhook_config
        ->isNonBlocking(),
      '#description' => $this
        ->t('Non-blocking <strong>incoming webhooks</strong> are stored in a queue for later processing.'),
    ];
    $form['outgoing'] = [
      '#title' => $this
        ->t('Outgoing Webhook Settings'),
      '#type' => 'details',
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#states' => [
        'expanded' => [
          ':input[name="type"]' => [
            'value' => 'outgoing',
          ],
        ],
        'enabled' => [
          ':input[name="type"]' => [
            'value' => 'outgoing',
          ],
        ],
        'required' => [
          ':input[name="type"]' => [
            'value' => 'outgoing',
          ],
        ],
        'collapsed' => [
          ':input[name="type"]' => [
            'value' => 'incoming',
          ],
        ],
        'disabled' => [
          ':input[name="type"]' => [
            'value' => 'incoming',
          ],
        ],
        'optional' => [
          ':input[name="type"]' => [
            'value' => 'incoming',
          ],
        ],
      ],
    ];
    $form['outgoing']['payload_url'] = [
      '#type' => 'url',
      '#title' => $this
        ->t('Payload URL'),
      '#attributes' => [
        'placeholder' => $this
          ->t('http://example.com/post'),
      ],
      '#default_value' => $webhook_config
        ->getPayloadUrl(),
      '#maxlength' => 255,
      '#description' => $this
        ->t('Target URL for your payload. Only used on <strong>outgoing webhooks</strong>.'),
    ];
    $form['outgoing']['events'] = [
      '#title' => $this
        ->t('Enabled Events'),
      '#type' => 'tableselect',
      '#header' => [
        'type' => $this
          ->t('Hook / Event'),
        'event' => $this
          ->t('Machine name'),
      ],
      '#description' => $this
        ->t("The Events you want to send to the endpoint."),
      '#options' => $this
        ->eventOptions(),
      '#default_value' => $webhook_config
        ->isNew() ? [] : $webhook_config
        ->getEvents(),
    ];
    if ($webhook_config
      ->getType() === 'incoming') {
      unset($form['outgoing']);
    }
    if ($webhook_config
      ->getType() === 'outgoing') {
      unset($form['incoming']);
    }
    $form['status'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Active"),
      '#description' => $this
        ->t("Shows if the webhook is active or not."),
      '#default_value' => $webhook_config
        ->isNew() ? TRUE : $webhook_config
        ->status(),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue('type') == 'incoming') {

      // payload_url is required but not used on incoming webhooks.
      // Skipping the value entirely could break data model assumptions.
      $form_state
        ->setValue('payload_url', 'http://example.com/webhook');
    }
    elseif ($form_state
      ->isValueEmpty('payload_url')) {
      $form_state
        ->setErrorByName('payload_url', $this
        ->t('Outgoing webhooks require a Payload URL'));
    }
    if ($form_state
      ->getValue('type') == 'outgoing' && $this
      ->isEmptyList($form_state
      ->getValue('events'))) {
      $form_state
        ->setErrorByName('events', $this
        ->t('Outgoing webhooks require one or more events to operate.'));
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {

    /** @var \Drupal\webhooks\Entity\WebhookConfig $webhook_config */
    $webhook_config = $this->entity;

    // Keep the old secret if no new one has been given.
    if (empty($form_state
      ->getValue('secret'))) {
      $webhook_config
        ->set('secret', $form['secret']['#default_value']);
    }
    $active = $webhook_config
      ->save();
    switch ($active) {
      case SAVED_NEW:
        $this
          ->messenger()
          ->addStatus($this
          ->t('Created the %label Webhook.', [
          '%label' => $webhook_config
            ->label(),
        ]));
        break;
      default:
        $this
          ->messenger()
          ->addStatus($this
          ->t('Saved the %label Webhook.', [
          '%label' => $webhook_config
            ->label(),
        ]));
    }

    /** @var \Drupal\Core\Url $url */
    $url = $webhook_config
      ->toUrl('collection');
    $form_state
      ->setRedirectUrl($url);
  }

  /**
   * Generate a list of available events.
   *
   * @return array
   *   Array of string identifiers for outgoing event options.
   */
  protected function eventOptions() {
    $entity_types = $this->entityTypeManager
      ->getDefinitions();
    $options = [];
    foreach ($entity_types as $entity_type => $definition) {
      if ($definition
        ->entityClassImplements('\\Drupal\\Core\\Entity\\ContentEntityInterface')) {
        foreach ($this->entityHooks as $hook) {
          $options['entity:' . $entity_type . ':' . $hook] = [
            'type' => $this
              ->t('Hook: %entity_label', [
              '%entity_label' => ucfirst($definition
                ->getLabel()),
            ]),
            'event' => 'entity:' . $entity_type . ':' . $hook,
          ];
        }
      }
    }
    foreach ($this->systemHooks as $hook) {
      $options['system:' . $hook] = [
        'type' => $this
          ->t('Hook: %hook', [
          '%hook' => ucfirst($hook),
        ]),
        'event' => 'system:' . $hook,
      ];
    }
    $this->moduleHandler
      ->alter('webhooks_event_info', $options);
    return $options;
  }

  /**
   * Identifies if an array of form values is empty.
   *
   * FormState::isValueEmpty() does not handle tableselect or #tree submissions.
   *
   * @param array $list
   *   Array of key value pairs. keys are identifiers, values are 0 if empty or
   *   the same value as the key if checked on.
   *
   * @return bool
   *   TRUE if empty, FALSE otherwise.
   */
  protected function isEmptyList(array $list) {
    return count(array_filter($list)) == 0;
  }

}

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
EntityForm::$entity protected property The entity being used by this form. 7
EntityForm::$operation protected property The name of the current operation.
EntityForm::$privateEntityManager private property The entity manager.
EntityForm::actions protected function Returns an array of supported actions for the current entity form. 29
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 2
EntityForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 10
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties 7
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 5
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 1
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 10
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init protected function Initialize the form state and the entity before the first form build. 3
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager public function Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::submitForm public function This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides FormInterface::submitForm 17
EntityForm::__get public function
EntityForm::__set public function
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.
WebhookConfigForm::$entityHooks protected property The entity hooks.
WebhookConfigForm::$entityTypeManager protected property The entity type manager. Overrides EntityForm::$entityTypeManager
WebhookConfigForm::$events protected property The events.
WebhookConfigForm::$moduleHandler protected property Module handler service. Overrides EntityForm::$moduleHandler
WebhookConfigForm::$systemHooks protected property The system hooks.
WebhookConfigForm::$webhookService protected property Webhook service.
WebhookConfigForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
WebhookConfigForm::eventOptions protected function Generate a list of available events.
WebhookConfigForm::form public function Gets the actual form array to be built. Overrides EntityForm::form
WebhookConfigForm::isEmptyList protected function Identifies if an array of form values is empty.
WebhookConfigForm::save public function Form submission handler for the 'save' action. Overrides EntityForm::save
WebhookConfigForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
WebhookConfigForm::__construct public function Webhook Config Form constructor.