You are here

Home » API reference » Twitter Profile Widget 8 » SettingsForm.php

class SettingsForm in Twitter Profile Widget 8

Same name and namespace in other branches
  1. 8.2 src/Form/SettingsForm.php \Drupal\twitter_profile_widget\Form\SettingsForm
  2. 3.x src/Form/SettingsForm.php \Drupal\twitter_profile_widget\Form\SettingsForm

Class SettingsForm.

@package Drupal\twitter_profile_widget\Form

Hierarchy

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'
twitter_profile_widget.routing.yml in ./twitter_profile_widget.routing.yml
twitter_profile_widget.routing.yml

File

src/Form/SettingsForm.php, line 15

Namespace

Drupal\twitter_profile_widget\Form
View source 
class SettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('twitter_profile_widget.settings');
    $form['twitter_widget_description'] = [
      '#markup' => $this
        ->t('Assign the Twitter App for this site. To register a new App, go to the <a href=":url">Twitter App page</a>.', [
        ':url' => 'https://apps.twitter.com/',
      ]),
    ];
    $form['integrate_blocks'] = [
      '#type' => 'checkbox',
      '#title' => 'Integrate with block system',
      '#description' => 'Auto-create/delete blocks when widgets are created/removed. This is the simplest way to place Twitter widgets conditionally on page(s).',
      '#default_value' => $config
        ->get('integrate_blocks'),
    ];
    $form['expire_internal_cache'] = [
      '#type' => 'checkbox',
      '#title' => 'Correctly expire page cache',
      '#description' => $this
        ->t('Use this if you have the Internal Page Cache enabled and are not using a memory-based cache such as Varnish. By default, the internal (anonymous) page cache will never expire, regardless of what you have set on the <a href=":url">Performance configuration page</a>. Checking this box will set the internal page cache to expire based on the "Page cache maximum age" setting. This change <em>only</em> applies to pages that include Twitter widgets.', [
        ':url' => '/admin/config/development/performance',
      ]),
      '#default_value' => $config
        ->get('expire_internal_cache'),
    ];
    $form['twitter_widget_key'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Twitter App Key'),
      '#maxlength' => 64,
      '#size' => 64,
      '#default_value' => $config
        ->get('twitter_widget_key'),
      '#required' => TRUE,
    ];
    $form['twitter_widget_secret'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Twitter App Secret'),
      '#maxlength' => 64,
      '#size' => 64,
      '#default_value' => $config
        ->get('twitter_widget_secret'),
      '#required' => TRUE,
    ];
    $form['twitter_widget_cache_time'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Refresh Interval (seconds)'),
      '#default_value' => $config
        ->get('twitter_widget_cache_time'),
      '#description' => $this
        ->t('The Twitter <a href=":url">rate limiting policy</a> requires you limit how frequently you pull new tweets. The general rule: do not pull more frequently (in minutes) than the number of widgets should exceed the number of individual widgets on the site (e.g., if there are 5 widgets, the cache lifetime should be at least 300 seconds).', [
        ':url' => 'https://dev.twitter.com/rest/public/rate-limits',
      ]),
    ];
    $form['twitter_widget_token'] = [
      '#type' => 'markup',
      '#markup' => t('<strong>API Token: </strong> :status', [
        ':status' => $config
          ->get('twitter_widget_token'),
      ]),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * Implements form validation.
   *
   * The validateForm method is the default method called to validate input on
   * a form.
   *
   * @param array $form
   *   The render array of the currently built form.
   * @param FormStateInterface $form_state
   *   Object describing the current state of the form.
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $Twitter = new TwitterProfile();
    $connection = $Twitter
      ->checkConnection($values['twitter_widget_key'], $values['twitter_widget_secret']);
    if ($connection === FALSE) {
      $form_state
        ->setErrorByName('twitter_widget_secret', $this
        ->t('Cannot connect to Twitter. Please check the Twitter account and credentials.'));
    }
    if ($connection !== TRUE) {
      $form_state
        ->setErrorByName('twitter_widget_secret', $result->errors[0]->message . $this
        ->t('The form has not been updated; any previously valid data you entered will remain active.'));
    }
  }

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

    // Invalidate cached Twitter data for widget views.
    Cache::invalidateTags([
      'twitter_widget_view',
    ]);
    $values = $form_state
      ->getValues();
    $this
      ->config('twitter_profile_widget.settings')
      ->set('integrate_blocks', $values['integrate_blocks'])
      ->set('expire_internal_cache', $values['expire_internal_cache'])
      ->set('twitter_widget_key', $values['twitter_widget_key'])
      ->set('twitter_widget_secret', $values['twitter_widget_secret'])
      ->set('twitter_widget_cache_time', $values['twitter_widget_cache_time'])
      ->set('twitter_widget_token', 'Credentials Valid')
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
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.
SettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SettingsForm::validateForm public function Implements form validation. Overrides FormBase::validateForm
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.