You are here

Home » API reference » Amazon Product Advertisement API 8.2 » SettingsForm.php

class SettingsForm in Amazon Product Advertisement API 8.2

Class SettingsForm.

@package Drupal\amazon_filter\Form

Hierarchy

Expanded class hierarchy of SettingsForm

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

File

src/Form/SettingsForm.php, line 19
Contains Drupal\amazon\Form\SettingsForm.

Namespace

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('amazon.settings');
    $description = '';
    $accessKey = Amazon::getAccessKey();
    $accessSecret = Amazon::getAccessSecret();
    if (empty($accessKey)) {
      $description = $this
        ->t('You must sign up for an Amazon AWS account to use the Product Advertising Service. See the <a href=":url">AWS home page</a> for information and a registration form. Enter your Access Key ID here.', [
        ':url' => 'https://aws-portal.amazon.com/gp/aws/developer/account/index.html?ie=UTF8&action=access-key',
      ]);
    }
    else {
      $description = $this
        ->t('The access key is set by another method and does not need to be entered here.');
    }
    $form['access_key'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Amazon AWS Access Key ID'),
      '#default_value' => $config
        ->get('access_key'),
      '#description' => $description,
      '#disabled' => !empty($accessKey),
    ];
    if (empty($accessKey)) {
      $description = $this
        ->t('You must sign up for an Amazon AWS account to use the Product Advertising Service. See the <a href=":url">AWS home page</a> for information and a registration form. Enter your Access Key Secret here.', [
        ':url' => 'https://aws-portal.amazon.com/gp/aws/developer/account/index.html?ie=UTF8&action=access-key',
      ]);
    }
    else {
      $description = $this
        ->t('The access secret is set by another method and does not need to be entered here.');
    }
    $form['access_secret'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Amazon AWS Access Secret'),
      '#default_value' => $config
        ->get('access_secret'),
      '#description' => $description,
      '#disabled' => !empty($accessSecret),
    ];
    $form['associates_id'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Amazon Associates ID'),
      '#description' => $this
        ->t('You must register as an <a href=":url">Associate with Amazon</a> before using this module.', [
        ':url' => 'http://docs.aws.amazon.com/AWSECommerceService/latest/DG/becomingAssociate.html',
      ]),
      '#default_value' => $config
        ->get('associates_id'),
    ];
    $max_age = $config
      ->get('default_max_age');
    if ($max_age == '') {

      // Defaults to 15 minutes.
      $max_age = '900';
    }
    $form['default_max_age'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default max-age for retrieved information'),
      '#description' => $this
        ->t('Number of seconds that the result from Amazon will be cached. This can be overridden by defining a different value in the text filter. Set to zero to disable caching by default.'),
      '#default_value' => $max_age,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if (empty(Amazon::getAccessKey()) && empty($form_state
      ->getValue('access_key'))) {
      $form_state
        ->setErrorByName('access_key', $this
        ->t('If you do not specify an access key here, you must use one of the other methods of providing this information, such as a server environment variable or a $config setting in settings.php.'));
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->config('amazon.settings')
      ->set('access_key', $form_state
      ->getValue('access_key'))
      ->set('access_secret', $form_state
      ->getValue('access_secret'))
      ->set('associates_id', $form_state
      ->getValue('associates_id'))
      ->set('default_max_age', $form_state
      ->getValue('default_max_age'))
      ->save();
  }

}

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 Form validation handler. 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.