class WebhooksSettingsForm in Acquia Content Hub 8

Defines the form to register the webhooks.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\acquia_contenthub\Form\WebhooksSettingsForm

Expanded class hierarchy of WebhooksSettingsForm

1 string reference to 'WebhooksSettingsForm'

acquia_contenthub.routing.yml in ./acquia_contenthub.routing.yml: acquia_contenthub.routing.yml

File

src/Form/WebhooksSettingsForm.php, line 16

Namespace

Drupal\acquia_contenthub\Form

View source

class WebhooksSettingsForm extends ConfigFormBase {

  /**
   * Config Factory.
   *
   * @var \Drupal\Core\Config\ConfigFactory
   */
  protected $configFactory;

  /**
   * Content Hub Subscription.
   *
   * @var \Drupal\acquia_contenthub\ContentHubSubscription
   */
  protected $contentHubSubscription;

  /**
   * WebhooksSettingsForm constructor.
   *
   * @param \Drupal\core\Config\ConfigFactoryInterface $config_factory
   *   The client manager.
   * @param \Drupal\acquia_contenthub\ContentHubSubscription $contenthub_subscription
   *   The content hub subscription.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ContentHubSubscription $contenthub_subscription) {
    $this->configFactory = $config_factory;
    $this->contentHubSubscription = $contenthub_subscription;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    /** @var \Drupal\Core\Config\ConfigFactoryInterface $config_factory */
    $config_factory = $container
      ->get('config.factory');

    /** @var \Drupal\acquia_contenthub\ContentHubSubscription $contenthub_subscription */
    $contenthub_subscription = $container
      ->get('acquia_contenthub.acquia_contenthub_subscription');
    return new static($config_factory, $contenthub_subscription);
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'acquia_contenthub.admin_settings';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'acquia_contenthub.admin_settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this->configFactory
      ->getEditable('acquia_contenthub.admin_settings');
    $form['webhook_settings'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Administer Webhooks'),
      '#collapsible' => TRUE,
      '#description' => $this
        ->t('Manage Acquia Content Hub Webhooks'),
    ];
    if ($config
      ->get('webhook_url')) {
      $webhook_url = $config
        ->get('webhook_url');
    }
    else {
      $webhook_url = Url::fromUri('internal:/acquia-contenthub/webhook', [
        'absolute' => TRUE,
      ])
        ->toString();
    }
    $webhook_uuid = $config
      ->get('webhook_uuid');

    // Match $remote_uuid via $webhook_url from service response.
    $remote_uuid = NULL;
    $settings = $this->contentHubSubscription
      ->getSettings();
    if ($settings) {

      // Ask service about webhooks.
      $webhooks = $settings
        ->getWebhooks();
      foreach ($webhooks as $webhook) {
        if ($webhook['url'] === $webhook_url) {
          $remote_uuid = $webhook['uuid'];
          break;
        }
      }
    }

    // Fix local state if it does not match service state.
    if ($remote_uuid != $webhook_uuid) {
      $config
        ->set('webhook_uuid', $remote_uuid);
      $config
        ->set('webhook_url', $webhook_url);
      $config
        ->save();
      $webhook_uuid = $remote_uuid;
    }
    if ((bool) $webhook_uuid) {
      $title = $this
        ->t('Receive Webhooks (uuid = %uuid)', [
        '%uuid' => $webhook_uuid,
      ]);
    }
    else {
      $title = $this
        ->t('Receive Webhooks');
    }
    $form['webhook_settings']['webhook_url'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Acquia Content Hub URL'),
      '#description' => $this
        ->t('Please use a full URL (Ex. http://example.com/acquia-contenthub/webhook). This is the end-point where this site will receive webhooks from Acquia Content Hub.'),
      '#default_value' => $webhook_url,
      '#required' => TRUE,
    ];
    $form['webhook_settings']['webhook_uuid'] = [
      '#type' => 'checkbox',
      '#title' => $title,
      '#default_value' => (bool) $webhook_uuid,
      '#description' => $this
        ->t('Webhooks must be enabled to receive updates from Acquia Content Hub'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if (!UrlHelper::isValid($form_state
      ->getValue('webhook_url'), TRUE)) {
      return $form_state
        ->setErrorByName('webhook_url', $this
        ->t('This is not a valid URL. Please insert it again.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $webhook_url = NULL;
    if ($form_state
      ->hasValue('webhook_url')) {
      $webhook_url = $form_state
        ->getValue('webhook_url');
    }
    $webhook_register = (bool) $form_state
      ->getValue('webhook_uuid');

    // Establish current uuid from config.
    $config = $this->configFactory
      ->getEditable('acquia_contenthub.admin_settings');
    $webhook_uuid = $config
      ->get('webhook_uuid');

    // User clicked Submit, but url is already registered.
    if ($webhook_register && $webhook_uuid) {
      $this
        ->messenger()
        ->addWarning($this
        ->t('No change in webhook status was taken.'));
    }
    elseif ($webhook_register) {
      $success = $this->contentHubSubscription
        ->registerWebhook($webhook_url);
      if (!$success) {
        $this
          ->messenger()
          ->addError($this
          ->t('There was a problem trying to register this webhook.'));
      }
    }
    else {
      $success = $this->contentHubSubscription
        ->unregisterWebhook($webhook_url);
      if (!$success) {
        $this
          ->messenger()
          ->addError($this
          ->t('There was a problem trying to unregister this webhook.'));
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
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::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
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.
WebhooksSettingsForm::$configFactory	protected	property	Config Factory. Overrides FormBase::$configFactory
WebhooksSettingsForm::$contentHubSubscription	protected	property	Content Hub Subscription.
WebhooksSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
WebhooksSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
WebhooksSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
WebhooksSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
WebhooksSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
WebhooksSettingsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
WebhooksSettingsForm::__construct	public	function	WebhooksSettingsForm constructor. Overrides ConfigFormBase::__construct

You are here

class WebhooksSettingsForm in Acquia Content Hub 8

Hierarchy

File

Namespace

Members

API Navigation