class SendGridReportsSettingsForm in SendGrid Integration 8.2

Same name and namespace in other branches

8 modules/sendgrid_integration_reports/src/Form/SendGridReportsSettingsForm.php \Drupal\sendgrid_integration_reports\Form\SendGridReportsSettingsForm

Class for Sendgrid reports settings form.

@package Drupal\sendgrid_integration_reports\Form

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\sendgrid_integration_reports\Form\SendGridReportsSettingsForm

Expanded class hierarchy of SendGridReportsSettingsForm

1 string reference to 'SendGridReportsSettingsForm'

sendgrid_integration_reports.routing.yml in modules/sendgrid_integration_reports/sendgrid_integration_reports.routing.yml: modules/sendgrid_integration_reports/sendgrid_integration_reports.routing.yml

File

modules/sendgrid_integration_reports/src/Form/SendGridReportsSettingsForm.php, line 16

Namespace

Drupal\sendgrid_integration_reports\Form

View source

class SendGridReportsSettingsForm extends ConfigFormBase {

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

  /**
   * Constructs a \Drupal\system\ConfigFormBase object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   The module handler service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ModuleHandlerInterface $moduleHandler) {
    parent::__construct($config_factory);
    $this->moduleHandler = $moduleHandler;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('sendgrid_integration_reports.settings')
      ->get();
    $form['sendgrid_integration_reports'] = [
      '#type' => 'container',
    ];
    $form['sendgrid_integration_reports']['message'] = [
      '#markup' => t('Data and responses from Sendgrid are cached for performance reasons. If you make changes to these settings charts cache will be dropped automatically.'),
    ];
    $current_date = date_format(new \Datetime(), 'Y-m-d');
    $form['sendgrid_integration_reports']['start_date'] = [
      '#type' => 'date',
      '#title' => t('Global Stats Start Date'),
      '#default_value' => !empty($config['start_date']) ? $config['start_date'] : date_format(new \Datetime('-30 days'), 'Y-m-d'),
      '#attributes' => [
        'type' => 'date',
        'max' => $current_date,
      ],
      '#required' => FALSE,
      '#description' => t('Start date in the format of mm/dd/YYYY. Defaults to 30 days back.'),
    ];
    $form['sendgrid_integration_reports']['end_date'] = [
      '#type' => 'date',
      '#title' => t('Global Stats End Date'),
      '#default_value' => !empty($config['end_date']) ? $config['end_date'] : $current_date,
      '#attributes' => [
        'type' => 'date',
        'max' => $current_date,
      ],
      '#required' => FALSE,
      '#description' => t('End date in the format of mm/dd/YYYY. Defaults to today.'),
    ];
    $options = [
      'day',
      'week',
      'month',
    ];
    $form['sendgrid_integration_reports']['aggregated_by'] = [
      '#type' => 'select',
      '#title' => t('Global Stats Aggregation'),
      '#default_value' => !empty($config['aggregated_by']) ? $config['aggregated_by'] : 0,
      '#required' => FALSE,
      '#description' => t('Aggregation of data. Defaults to day.'),
      '#options' => array_combine($options, $options),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    if (strtotime($values['start_date']) > strtotime($values['end_date'])) {
      $form_state
        ->setError($form['sendgrid_integration_reports']['start_date'], t('The %start could not be later than %end.', [
        '%start' => $form['sendgrid_integration_reports']['start_date']['#title'],
        '%end' => $form['sendgrid_integration_reports']['end_date']['#title'],
      ]));
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('sendgrid_integration_reports.settings');
    $values = $form_state
      ->getValues();
    $elems = [
      'start_date',
      'end_date',
      'aggregated_by',
    ];
    foreach ($elems as $elem) {
      $config
        ->set($elem, $values[$elem]);
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);

    // Clear the cache since the settings have been changed.
    \Drupal::cache('sendgrid_integration_reports')
      ->deleteAll();
  }

}

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.
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.
SendGridReportsSettingsForm::$moduleHandler	protected	property	The module handler service.
SendGridReportsSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
SendGridReportsSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
SendGridReportsSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SendGridReportsSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SendGridReportsSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
SendGridReportsSettingsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
SendGridReportsSettingsForm::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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 SendGridReportsSettingsForm in SendGrid Integration 8.2

Hierarchy

File

Namespace

Members

API Navigation