You are here

Home » API reference » Campaign Monitor 8 » CampaignMonitorCampaignAdminForm.php

class CampaignMonitorCampaignAdminForm in Campaign Monitor 8

Configure campaignmonitor settings for this site.

Hierarchy

Expanded class hierarchy of CampaignMonitorCampaignAdminForm

1 string reference to 'CampaignMonitorCampaignAdminForm'
campaignmonitor_campaign.routing.yml in modules/campaignmonitor_campaign/campaignmonitor_campaign.routing.yml
modules/campaignmonitor_campaign/campaignmonitor_campaign.routing.yml

File

modules/campaignmonitor_campaign/src/Form/CampaignMonitorCampaignAdminForm.php, line 11

Namespace

Drupal\campaignmonitor_campaign\Form
View source 
class CampaignMonitorCampaignAdminForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormID() {
    return 'campaignmonitor_campaign_admin_settings';
  }

  /**
   *
   */
  protected function getEditableConfigNames() {
    return [
      'campaignmonitor_campaign.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('campaignmonitor_campaign.settings');
    $types = node_type_get_types();
    $options = [];
    foreach ($types as $name => $type) {
      $options[$name] = $type
        ->label();
    }
    $default = $config
      ->get('node_types') != NULL ? $config
      ->get('node_types') : [];
    $form['campaignmonitor_types'] = [
      '#type' => 'fieldset',
      '#title' => t('Node Types'),
      '#description' => t('Select node types to use as Campaigns'),
      '#collapsible' => empty($config) ? FALSE : TRUE,
      '#collapsed' => empty($config) ? FALSE : TRUE,
      '#tree' => TRUE,
    ];
    $form['campaignmonitor_types']['node_types'] = [
      '#type' => 'checkboxes',
      '#options' => $options,
      '#title' => t('Node types'),
      '#description' => t('Any selected node types can be used to send Campaigns'),
      '#default_value' => $default,
      '#required' => TRUE,
    ];
    $form['campaignmonitor_custom'] = [
      '#type' => 'fieldset',
      '#title' => t('Custom Settings'),
      '#description' => t('Some optional customizations'),
      '#collapsible' => empty($config) ? FALSE : TRUE,
      '#collapsed' => empty($config) ? FALSE : TRUE,
      '#tree' => TRUE,
    ];
    $form['campaignmonitor_custom']['custom_store'] = [
      '#type' => 'checkbox',
      '#title' => t('Custom Directory'),
      '#description' => t('By default campaign html files are stored in the public files directory.  Select this if
      you want to nominate a custom directory.'),
      '#default_value' => $config
        ->get('custom_store'),
      '#attributes' => [
        'class' => [
          'custom-store-checkbox',
        ],
      ],
    ];
    $form['campaignmonitor_custom']['custom_directory'] = [
      '#type' => 'textfield',
      '#title' => t('Custom Directory Path'),
      '#description' => t('Enter the path of the directory within Drupal root.'),
      '#default_value' => $config
        ->get('custom_directory'),
      '#states' => [
        'visible' => [
          '.custom-store-checkbox' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['css_library'] = [
      '#type' => 'textfield',
      '#title' => t('CSS library'),
      '#description' => t('Enter the name of the CSS library to use for Campaigns.  This should be in the form
      MODULENAME/LIBRARYNAME.'),
      '#default_value' => $config
        ->get('css_library'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('campaignmonitor_campaign.settings');
    $config
      ->set('custom_store', $form_state
      ->getValue([
      'campaignmonitor_custom',
      'custom_store',
    ]))
      ->set('custom_directory', $form_state
      ->getValue([
      'campaignmonitor_custom',
      'custom_directory',
    ]))
      ->set('node_types', $form_state
      ->getValue([
      'campaignmonitor_types',
      'node_types',
    ]))
      ->set('css_library', $form_state
      ->getValue('css_library'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CampaignMonitorCampaignAdminForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
CampaignMonitorCampaignAdminForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
CampaignMonitorCampaignAdminForm::getFormID public function
CampaignMonitorCampaignAdminForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
CampaignMonitorCampaignAdminForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
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.
FormInterface::getFormId public function Returns a unique string identifying the form. 236
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.