You are here

Home » API reference » Google AdSense integration 8 » AdsenseManagedSettings.php

class AdsenseManagedSettings in Google AdSense integration 8

Form for the adsense managed ads settings.

Hierarchy

Expanded class hierarchy of AdsenseManagedSettings

1 string reference to 'AdsenseManagedSettings'
adsense.routing.yml in ./adsense.routing.yml
adsense.routing.yml

File

src/Form/AdsenseManagedSettings.php, line 18

Namespace

Drupal\adsense\Form
View source 
class AdsenseManagedSettings extends ConfigFormBase {

  /**
   * Request path condition plugin.
   *
   * @var \Drupal\system\Plugin\Condition\RequestPath
   */
  protected $condition;

  /**
   * Constructs a \Drupal\adsense\Form\AdsenseManagedSettings object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Component\Plugin\Factory\FactoryInterface $plugin_factory
   *   The factory for condition plugin objects.
   */
  public function __construct(ConfigFactoryInterface $config_factory, FactoryInterface $plugin_factory) {
    parent::__construct($config_factory);
    try {
      $this->condition = $plugin_factory
        ->createInstance('request_path');
    } catch (PluginException $e) {

      // System is badly broken if we can't get the condition plugin.
      $this->condition = NULL;
    }
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('adsense.settings');
    $form['adsense_managed_async'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use asynchronous ad code?'),
      '#default_value' => $config
        ->get('adsense_managed_async'),
      '#description' => $this
        ->t('This will enable the asynchronous ad code type. [@moreinfo]', [
        '@moreinfo' => Link::fromTextAndUrl($this
          ->t('More information'), Url::fromUri('https://support.google.com/adsense/answer/3221666'))
          ->toString(),
      ]),
    ];
    $form['adsense_managed_defer'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Defer javascript loading?'),
      '#default_value' => $config
        ->get('adsense_managed_defer'),
      '#description' => $this
        ->t('This will defer the execution of the ad script until the page is loaded'),
    ];
    $form['adsense_managed_page_level_ads_enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable auto ads?'),
      '#default_value' => $config
        ->get('adsense_managed_page_level_ads_enabled'),
      '#description' => $this
        ->t('This will enable Auto ads. [@moreinfo]', [
        '@moreinfo' => Link::fromTextAndUrl($this
          ->t('More information'), Url::fromUri('https://support.google.com/adsense/answer/7478040'))
          ->toString(),
      ]),
    ];

    // Auto ads visibility.
    $form['visibility'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Auto ads visibility'),
      '#states' => [
        'invisible' => [
          ":input[name='adsense_managed_page_level_ads_enabled']" => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    if ($config
      ->get('adsense_access_pages')) {
      $this->condition
        ->setConfiguration($config
        ->get('adsense_access_pages'));
    }
    $form['visibility'] += $this->condition
      ->buildConfigurationForm($form['visibility'], $form_state);
    $form['visibility']['negate']['#type'] = 'radios';
    $form['visibility']['negate']['#default_value'] = (int) $form['visibility']['negate']['#default_value'];
    $form['visibility']['negate']['#title_display'] = 'invisible';
    $form['visibility']['negate']['#options'] = [
      $this
        ->t('Show for the listed pages'),
      $this
        ->t('Hide for the listed pages'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->configFactory()
      ->getEditable('adsense.settings');
    $form_state
      ->cleanValues();
    $this->condition
      ->submitConfigurationForm($form, $form_state);
    $config
      ->set('adsense_access_pages', $this->condition
      ->getConfiguration());

    // Don't store the condition values separately.
    $values = $form_state
      ->getValues();
    unset($values['pages']);
    unset($values['negate']);
    foreach ($values as $key => $value) {
      $config
        ->set($key, Html::escape($value));
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AdsenseManagedSettings::$condition protected property Request path condition plugin.
AdsenseManagedSettings::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
AdsenseManagedSettings::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
AdsenseManagedSettings::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AdsenseManagedSettings::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AdsenseManagedSettings::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
AdsenseManagedSettings::__construct public function Constructs a \Drupal\adsense\Form\AdsenseManagedSettings 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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.