You are here

class AmpSettingsForm in Accelerated Mobile Pages (AMP) 8

Same name and namespace in other branches
  1. 8.3 src/Form/AmpSettingsForm.php \Drupal\amp\Form\AmpSettingsForm
  2. 8.2 src/Form/AmpSettingsForm.php \Drupal\amp\Form\AmpSettingsForm

Defines the configuration export form.

Hierarchy

Expanded class hierarchy of AmpSettingsForm

1 string reference to 'AmpSettingsForm'
amp.routing.yml in ./amp.routing.yml
amp.routing.yml

File

src/Form/AmpSettingsForm.php, line 17

Namespace

Drupal\amp\Form
View source
class AmpSettingsForm extends ConfigFormBase {

  /**
   * The theme handler service.
   *
   * @var \Drupal\Core\Extension\ThemeHandlerInterface
   */
  protected $themeHandler;

  /**
   * The array of valid theme options.
   *
   * @array $themeOptions
   */
  private $themeOptions;

  /**
   * The cache tags invalidator.
   *
   * @var \Drupal\Core\Cache\CacheTagsInvalidatorInterface
   */
  protected $tagInvalidate;

  /**
   * Information about AMP-enabled content types.
   *
   * @var \Drupal\amp\EntityTypeInfo
   */
  protected $entityTypeInfo;

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

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

  /*
   * Helper function to get available theme options.
   *
   * @return array
   *   Array of valid themes.
   */
  private function getThemeOptions() {

    // Get all available themes.
    $themes = $this->themeHandler
      ->rebuildThemeData();
    uasort($themes, 'system_sort_modules_by_info_name');
    $theme_options = [];
    foreach ($themes as $theme) {
      if (!empty($theme->info['hidden'])) {
        continue;
      }
      else {
        if (!empty($theme->status) && !empty($theme->base_themes) && (array_key_exists('amptheme', $theme->base_themes) || $theme->info['name'] == 'AMP Base')) {
          $theme_options[$theme
            ->getName()] = $theme->info['name'];
        }
      }
    }
    return $theme_options;
  }

  /**
   * Constructs a AmpSettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
   *   The theme handler.
   * @param \Drupal\Core\Cache\CacheTagsInvalidatorInterface $tag_invalidate
   *   The cache tags invalidator.
   * @param \Drupal\amp\EntityTypeInfo $entity_type_info
   *   Information about AMP-enabled content types.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ThemeHandlerInterface $theme_handler, CacheTagsInvalidatorInterface $tag_invalidate, EntityTypeInfo $entity_type_info) {
    parent::__construct($config_factory);
    $this->themeHandler = $theme_handler;
    $this->themeOptions = $this
      ->getThemeOptions();
    $this->tagInvalidate = $tag_invalidate;
    $this->entityTypeInfo = $entity_type_info;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $amp_config = $this
      ->config('amp.settings');
    if (\Drupal::moduleHandler()
      ->moduleExists('field_ui')) {
      $form['amp_content_amp_status'] = [
        '#title' => $this
          ->t('AMP Status by Content Type'),
        '#theme' => 'item_list',
        '#items' => $this->entityTypeInfo
          ->getFormattedAmpEnabledTypes(),
      ];
    }
    else {
      $form['amp_content_amp_status'] = [
        '#type' => 'item',
        '#title' => $this
          ->t('AMP Status by Content Type'),
        '#markup' => $this
          ->t('(In order to enable and disable AMP content types in the UI, the Field UI module must be enabled.)'),
      ];
    }
    $amptheme_config = $this
      ->config('amp.theme');
    $form['amptheme'] = [
      '#type' => 'select',
      '#options' => $this->themeOptions,
      '#required' => TRUE,
      '#title' => $this
        ->t('AMP theme'),
      '#description' => $this
        ->t('Choose a theme to use for AMP pages.'),
      '#default_value' => $amptheme_config
        ->get('amptheme'),
    ];
    if (empty($this->themeOptions)) {
      $form['amptheme']['#description'] = $this
        ->t('To use the AMP module, the AMP Base theme must be installed. You must choose between AMP Base or an installed subtheme of AMP Base, such as the ExAMPle Subtheme, for use as the AMP Theme in order to provide custom styles on AMP pages.');
    }
    $form['google_analytics_id'] = [
      '#type' => 'textfield',
      '#default_value' => $amp_config
        ->get('google_analytics_id'),
      '#title' => $this
        ->t('Google Analytics Web Property ID'),
      '#description' => $this
        ->t('This ID is unique to each site you want to track separately, and is in the form of UA-xxxxxxx-yy. To get a Web Property ID, <a href=":analytics">register your site with Google Analytics</a>, or if you already have registered your site, go to your Google Analytics Settings page to see the ID next to every site profile. <a href=":webpropertyid">Find more information in the documentation</a>.', [
        ':analytics' => 'http://www.google.com/analytics/',
        ':webpropertyid' => Url::fromUri('https://developers.google.com/analytics/resources/concepts/gaConceptsAccounts', [
          'fragment' => 'webProperty',
        ])
          ->toString(),
      ]),
      '#maxlength' => 20,
      '#size' => 15,
      '#placeholder' => 'UA-',
    ];
    $form['google_adsense_id'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Google AdSense Publisher ID'),
      '#default_value' => $amp_config
        ->get('google_adsense_id'),
      '#maxlength' => 25,
      '#size' => 20,
      '#placeholder' => 'pub-',
      '#description' => $this
        ->t('This is the Google AdSense Publisher ID for the site owner. Get this in your Google Adsense account. It should be similar to pub-9999999999999'),
    );
    $form['google_doubleclick_id'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Google DoubleClick for Publishers Network ID'),
      '#default_value' => $amp_config
        ->get('google_doubleclick_id'),
      '#maxlength' => 25,
      '#size' => 20,
      '#placeholder' => '/',
      '#description' => $this
        ->t('The Network ID to use on all tags. This value should begin with a /.'),
    );
    $form['pixel_group'] = array(
      '#type' => 'fieldset',
      '#title' => t('amp-pixel'),
    );
    $form['pixel_group']['amp_pixel'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable amp-pixel'),
      '#default_value' => $amp_config
        ->get('amp_pixel'),
      '#description' => $this
        ->t('The amp-pixel element is meant to be used as a typical tracking pixel -- to count page views. Find more information in the <a href="https://www.ampproject.org/docs/reference/amp-pixel.html">amp-pixel documentation</a>.'),
    );
    $form['pixel_group']['amp_pixel_domain_name'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('amp-pixel domain name'),
      '#default_value' => $amp_config
        ->get('amp_pixel_domain_name'),
      '#description' => $this
        ->t('The domain name where the tracking pixel will be loaded: do not include http or https.'),
      '#states' => array(
        'visible' => array(
          ':input[name="amp_pixel"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    $form['pixel_group']['amp_pixel_query_string'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('amp-pixel query path'),
      '#default_value' => $amp_config
        ->get('amp_pixel_query_string'),
      '#description' => $this
        ->t('The path at the domain where the GET request will be received, e.g. "pixel" in example.com/pixel?RANDOM.'),
      '#states' => array(
        'visible' => array(
          ':input[name="amp_pixel"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    $form['pixel_group']['amp_pixel_random_number'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Random number'),
      '#default_value' => $amp_config
        ->get('amp_pixel_random_number'),
      '#description' => $this
        ->t('Use the special string RANDOM to add a random number to the URL if required. Find more information in the <a href="https://github.com/ampproject/amphtml/blob/master/spec/amp-var-substitutions.md#random">amp-pixel documentation</a>.'),
      '#states' => array(
        'visible' => array(
          ':input[name="amp_pixel"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    $form['amp_library_group'] = array(
      '#type' => 'fieldset',
      '#title' => t('AMP Library Configuration <a href="https://github.com/Lullabot/amp-library">(GitHub Home and Documentation)</a>'),
    );
    $form['amp_library_group']['test_page'] = array(
      '#type' => 'item',
      '#markup' => t('<a href=":url">Test that AMP is configured properly</a>', array(
        ':url' => Url::fromRoute('amp.test_library_hello')
          ->toString(),
      )),
    );
    $form['amp_library_group']['amp_library_warnings_display'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('<em>Debugging</em>: Show AMP Library warnings in <em>all</em> AMP text formatters for <em>all</em> users'),
      '#default_value' => $amp_config
        ->get('amp_library_warnings_display'),
      '#description' => $this
        ->t('If you only want to see AMP formatter specific warning for one node add query ' . '"warnfix=1" at end of a node url. e.g. <strong>node/12345?amp&warnfix=1</strong>'),
    );
    $form['amp_library_group']['amp_library_process_full_html'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('<strong><em>Power User:</em> Run the whole HTML page through the AMP library</strong>'),
      '#default_value' => $amp_config
        ->get('amp_library_process_full_html'),
      '#description' => $this
        ->t('The AMP PHP library will fix many AMP HTML standard non-compliance issues by ' . 'removing illegal or disallowed attributes, tags and property value pairs. This is useful for processing the output of modules that ' . 'generate AMP unfriendly HTML. Please test when enabling on your site as some modules may depend on ' . 'the HTML removed by the library and thus break in possibly subtle ways.'),
    );
    $form['amp_library_group']['amp_library_process_statistics'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('<em>Statistics:</em> Add an <a href="https://www.drupal.org/files/issues/time_taken.png">HTML comment</a> at the end of Drupal page output indicating various performance statistics like time taken, number of tags processed etc.'),
      '#default_value' => $amp_config
        ->get('amp_library_process_statistics'),
      '#states' => array(
        'visible' => array(
          ':input[name="amp_library_process_full_html"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    $form['amp_library_group']['amp_library_process_full_html_warnings'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('<em>Debugging:</em> Add a notice in the drupal log for each processed AMP page showing the AMP warnings (and fixes) generated'),
      '#default_value' => $amp_config
        ->get('amp_library_process_full_html_warnings'),
      '#description' => $this
        ->t('A Drupal log entry will be generated for <em>each</em> non-anonymous AMP request. ' . 'However <em>anonymous</em> page requests will be cached by Drupal page_cache module and will not repeatedly call the AMP library.'),
      '#states' => array(
        'visible' => array(
          ':input[name="amp_library_process_full_html"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    return parent::buildForm($form, $form_state);
  }

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

    // Validate the Google Analytics ID.
    if (!empty($form_state
      ->getValue('google_analytics_id'))) {
      $form_state
        ->setValue('google_analytics_id', trim($form_state
        ->getValue('google_analytics_id')));

      // Replace all type of dashes (n-dash, m-dash, minus) with normal dashes.
      $form_state
        ->setValue('google_analytics_id', str_replace([
        '–',
        '—',
        '−',
      ], '-', $form_state
        ->getValue('google_analytics_id')));
      if (!preg_match('/^UA-\\d+-\\d+$/', $form_state
        ->getValue('google_analytics_id'))) {
        $form_state
          ->setErrorByName('google_analytics_id', t('A valid Google Analytics Web Property ID is case sensitive and formatted like UA-xxxxxxx-yy.'));
      }
    }

    // Validate the Google Adsense ID.
    if (!empty($form_state
      ->getValue('google_adsense_id'))) {
      $form_state
        ->setValue('google_adsense_id', trim($form_state
        ->getValue('google_adsense_id')));
      if (!preg_match('/^pub-[0-9]+$/', $form_state
        ->getValue('google_adsense_id'))) {
        $form_state
          ->setErrorByName('google_adsense_id', t('A valid Google AdSense Publisher ID is case sensitive and formatted like pub-9999999999999'));
      }
    }
  }

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

    // AMP theme settings.
    $amptheme = $form_state
      ->getValue('amptheme');
    $amptheme_config = $this
      ->config('amp.theme');
    $amptheme_config
      ->setData([
      'amptheme' => $amptheme,
    ]);
    $amptheme_config
      ->save();

    // Other module settings.
    $amp_config = $this
      ->config('amp.settings');
    $amp_config
      ->set('google_analytics_id', $form_state
      ->getValue('google_analytics_id'))
      ->save();
    $amp_config
      ->set('google_adsense_id', $form_state
      ->getValue('google_adsense_id'))
      ->save();
    $amp_config
      ->set('google_doubleclick_id', $form_state
      ->getValue('google_doubleclick_id'))
      ->save();
    $amp_config
      ->set('amp_pixel', $form_state
      ->getValue('amp_pixel'))
      ->save();
    $amp_config
      ->set('amp_pixel_domain_name', $form_state
      ->getValue('amp_pixel_domain_name'))
      ->save();
    $amp_config
      ->set('amp_pixel_query_string', $form_state
      ->getValue('amp_pixel_query_string'))
      ->save();
    $amp_config
      ->set('amp_pixel_random_number', $form_state
      ->getValue('amp_pixel_random_number'))
      ->save();
    $amp_config
      ->set('amp_library_process_full_html', $form_state
      ->getValue('amp_library_process_full_html'))
      ->save();
    $amp_config
      ->set('amp_library_process_full_html_warnings', $form_state
      ->getValue('amp_library_process_full_html_warnings'))
      ->save();
    $amp_config
      ->set('amp_library_process_statistics', $form_state
      ->getValue('amp_library_process_statistics'))
      ->save();
    if ($form_state
      ->getValue('amp_library_warnings_display') !== $amp_config
      ->get('amp_library_warnings_display')) {
      $amp_config
        ->set('amp_library_warnings_display', $form_state
        ->getValue('amp_library_warnings_display'))
        ->save();
      $this->tagInvalidate
        ->invalidateTags([
        'amp-warnings',
      ]);
    }
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AmpSettingsForm::$entityTypeInfo protected property Information about AMP-enabled content types.
AmpSettingsForm::$tagInvalidate protected property The cache tags invalidator.
AmpSettingsForm::$themeHandler protected property The theme handler service.
AmpSettingsForm::$themeOptions private property The array of valid theme options.
AmpSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
AmpSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
AmpSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AmpSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AmpSettingsForm::getThemeOptions private function
AmpSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
AmpSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
AmpSettingsForm::__construct public function Constructs a AmpSettingsForm object. Overrides ConfigFormBase::__construct
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.
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.