You are here

Home » API reference » Campaign Monitor 8.2 » CampaignMonitorSubscribeBlock.php

class CampaignMonitorSubscribeBlock in Campaign Monitor 8.2

Same name and namespace in other branches
  1. 8 src/Plugin/Block/CampaignMonitorSubscribeBlock.php \Drupal\campaignmonitor\Plugin\Block\CampaignMonitorSubscribeBlock

Provides a 'Subscribe' block.

Plugin annotation


@Block(
  id = "campaignmonitor_subscribe_block",
  admin_label = @Translation("Subscribe Block"),
  category = @Translation("Campaign Monitor Signup"),
  module = "campaignmonitor",
)

Hierarchy

Expanded class hierarchy of CampaignMonitorSubscribeBlock

File

src/Plugin/Block/CampaignMonitorSubscribeBlock.php, line 25

Namespace

Drupal\campaignmonitor\Plugin\Block
View source 
class CampaignMonitorSubscribeBlock extends BlockBase implements BlockPluginInterface, ContainerFactoryPluginInterface {

  /**
   * The campaignmonitor manager service.
   *
   * @var Drupal\campaignmonitor\CampaignMonitorManager
   */
  protected $campaignMonitorManager;

  /**
   * The campaign monitor subscribe manager.
   *
   * @var Drupal\campaignmonitor\CampaignMonitorSubscriptionManager
   */
  protected $campaignMonitorSubscriptionManager;

  /**
   * Vendor/campaignmonitor/create-send-php.
   *
   * @var mixed
   */
  protected $createSendManager;

  /**
   * The form builder.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * Constructs a CampaignMonitorSubscribeBlock object.
   *
   * @param mixed[] $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\campaignmonitor\CampaignMonitorManager $campaignmonitor_manager
   *   The campaign monitor manager.
   * @param \Drupal\campaignmonitor\CampaignMonitorSubscriptionManager $campaignmonitor_subscription_manager
   *   The campaign monitor subscription manager.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, CampaignMonitorManager $campaignmonitor_manager, CampaignMonitorSubscriptionManager $campaignmonitor_subscription_manager, FormBuilderInterface $form_builder) {
    $this->campaignMonitorManager = $campaignmonitor_manager;
    $this->createSendManager = $this->campaignMonitorManager
      ->createClientObj();
    $this->campaignMonitorSubscriptionManager = $campaignmonitor_subscription_manager;
    $this->formBuilder = $form_builder;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    // Instantiates this form class.
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('campaignmonitor.manager'), $container
      ->get('campaignmonitor.subscription_manager'), $container
      ->get('form_builder'));
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $config = $this
      ->getConfiguration();
    $form += $this->campaignMonitorSubscriptionManager
      ->subscribeSettingsForm($config);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockValidate($form, FormStateInterface $form_state) {
    $subscribe_option = $form_state
      ->getValue([
      'campaignmonitor',
      'list',
    ]);
    if ($subscribe_option == 'single') {
      $list_id = $form_state
        ->getValue([
        'campaignmonitor',
        'list_id',
      ]);
      if (empty($list_id)) {
        $form_state
          ->setErrorByName('settings[campaignmonitor][list_id]', 'List Selection required');
      }
    }
    if ($subscribe_option == 'segments') {
      $segment_list_id = $form_state
        ->getValue([
        'campaignmonitor',
        'segment_list_id',
      ]);
      if (empty($segment_list_id)) {
        $form_state
          ->setErrorByName('settings[campaignmonitor][segment_list_id]', 'List Selection required');
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['list'] = $form_state
      ->getValue([
      'lists',
      'list',
    ]);
    $this->configuration['list_id'] = $form_state
      ->getValue([
      'lists',
      'list_id',
    ]);
    $this->configuration['list_id_text'] = $form_state
      ->getValue([
      'lists',
      'list_id_text',
    ]);
    $this->configuration['segment_list_id'] = $form_state
      ->getValue([
      'lists',
      'segment_list_id',
    ]);
    $this->configuration['custom_fields_visible'] = $form_state
      ->getValue([
      'custom_fields',
      'custom_fields_visible',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $config = $this
      ->getConfiguration();
    $content = $this->formBuilder
      ->getForm('\\Drupal\\campaignmonitor\\Form\\CampaignMonitorSubscribeForm', $config);
    return $content;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return Cache::mergeContexts(parent::getCacheContexts(), [
      'user',
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess protected function Indicates whether the block should be shown. 16
BlockPluginTrait::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. 2
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::defaultConfiguration public function 19
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). 1
CampaignMonitorSubscribeBlock::$campaignMonitorManager protected property The campaignmonitor manager service.
CampaignMonitorSubscribeBlock::$campaignMonitorSubscriptionManager protected property The campaign monitor subscribe manager.
CampaignMonitorSubscribeBlock::$createSendManager protected property Vendor/campaignmonitor/create-send-php.
CampaignMonitorSubscribeBlock::$formBuilder protected property The form builder.
CampaignMonitorSubscribeBlock::blockForm public function Returns the configuration form elements specific to this block plugin. Overrides BlockPluginTrait::blockForm
CampaignMonitorSubscribeBlock::blockSubmit public function Adds block type-specific submission handling for the block form. Overrides BlockPluginTrait::blockSubmit
CampaignMonitorSubscribeBlock::blockValidate public function Adds block type-specific validation for the block form. Overrides BlockPluginTrait::blockValidate
CampaignMonitorSubscribeBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
CampaignMonitorSubscribeBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
CampaignMonitorSubscribeBlock::getCacheContexts public function The cache contexts associated with this object. Overrides ContextAwarePluginBase::getCacheContexts
CampaignMonitorSubscribeBlock::__construct public function Constructs a CampaignMonitorSubscribeBlock object. Overrides BlockPluginTrait::__construct
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get public function Implements magic __get() method.
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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass public function
PluginWithFormsTrait::hasFormClass public function
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.
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2