class MailchimpListsWebhookSettingsForm in Mailchimp 8

Same name and namespace in other branches

2.x modules/mailchimp_lists/src/Form/MailchimpListsWebhookSettingsForm.php \Drupal\mailchimp_lists\Form\MailchimpListsWebhookSettingsForm

Configure settings for a Mailchimp list webhook.

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\mailchimp_lists\Form\MailchimpListsWebhookSettingsForm

Expanded class hierarchy of MailchimpListsWebhookSettingsForm

1 string reference to 'MailchimpListsWebhookSettingsForm'

mailchimp_lists.routing.yml in modules/mailchimp_lists/mailchimp_lists.routing.yml: modules/mailchimp_lists/mailchimp_lists.routing.yml

File

modules/mailchimp_lists/src/Form/MailchimpListsWebhookSettingsForm.php, line 14

Namespace

Drupal\mailchimp_lists\Form

View source

class MailchimpListsWebhookSettingsForm extends ConfigFormBase {

  /**
   * The messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * Constructs a MailchimpListsWebhookSettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, MessengerInterface $messenger) {
    parent::__construct($config_factory);
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('messenger'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'mailchimp_lists_webhook_settings';
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $list_id = $this
      ->getRequest()->attributes
      ->get('_raw_variables')
      ->get('list_id');
    $list = mailchimp_get_list($list_id);
    $form_state
      ->set('list', $list);
    $default_webhook_events = mailchimp_lists_default_webhook_events();
    $enabled_webhook_events = mailchimp_lists_enabled_webhook_events($list_id);
    $form['webhook_events'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Enabled webhook events for the @name audience', [
        '@name' => $list->name,
      ]),
      '#tree' => TRUE,
    ];
    foreach ($default_webhook_events as $event => $name) {
      $form['webhook_events'][$event] = [
        '#type' => 'checkbox',
        '#title' => $name,
        '#default_value' => in_array($event, $enabled_webhook_events),
      ];
    }
    return parent::buildForm($form, $form_state);
  }

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

    /* @var \Mailchimp\MailchimpLists $mc_lists */
    $mc_lists = mailchimp_get_api_object('MailchimpLists');
    $list = $form_state
      ->get('list');
    $webhook_events = $form_state
      ->getValue('webhook_events');
    $events = [];
    foreach ($webhook_events as $webhook_id => $enable) {
      $events[$webhook_id] = $enable === 1;
    }
    $result = FALSE;
    if (count($events) > 0) {
      $webhook_url = mailchimp_webhook_url();
      $webhooks = mailchimp_webhook_get($list->id);
      if (!empty($webhooks)) {
        foreach ($webhooks as $webhook) {
          if ($webhook->url == $webhook_url) {

            // Delete current webhook.
            mailchimp_webhook_delete($list->id, mailchimp_webhook_url());
          }
        }
      }
      $sources = [
        'user' => TRUE,
        'admin' => TRUE,
        'api' => FALSE,
      ];

      // Add webhook with enabled events.
      $result = mailchimp_webhook_add($list->id, mailchimp_webhook_url(), $events, $sources);
    }
    if ($result) {
      $this->messenger
        ->addStatus($this
        ->t('Webhooks for audience "%name" have been updated.', [
        '%name' => $list->name,
      ]));
    }
    else {
      $this->messenger
        ->addWarning($this
        ->t('Unable to update webhooks for audience "%name".', [
        '%name' => $list->name,
      ]));
    }
    $form_state
      ->setRedirect('mailchimp_lists.overview');
  }

}

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::$configFactory	protected	property	The config factory.	1
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.
MailchimpListsWebhookSettingsForm::$messenger	protected	property	The messenger service. Overrides MessengerTrait::$messenger
MailchimpListsWebhookSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
MailchimpListsWebhookSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
MailchimpListsWebhookSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
MailchimpListsWebhookSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
MailchimpListsWebhookSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
MailchimpListsWebhookSettingsForm::__construct	public	function	Constructs a MailchimpListsWebhookSettingsForm object. Overrides ConfigFormBase::__construct
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.

You are here

class MailchimpListsWebhookSettingsForm in Mailchimp 8

Hierarchy

File

Namespace

Members

API Navigation