You are here

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

class AdsenseRevenueSharingBasicSettings in Google AdSense integration 8

Form for the adsense revenue sharing settings.

Hierarchy

Expanded class hierarchy of AdsenseRevenueSharingBasicSettings

1 string reference to 'AdsenseRevenueSharingBasicSettings'
adsense_revenue_sharing_basic.routing.yml in oldcode/revenue_sharing_basic/adsense_revenue_sharing_basic.routing.yml
oldcode/revenue_sharing_basic/adsense_revenue_sharing_basic.routing.yml

File

oldcode/revenue_sharing_basic/src/Form/AdsenseRevenueSharingBasicSettings.php, line 15

Namespace

Drupal\adsense_revenue_sharing_basic\Form
View source 
class AdsenseRevenueSharingBasicSettings extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    module_load_include('inc', 'adsense_revenue_sharing_basic', 'help/adsense_revenue_sharing_basic.help');
    $config = $this
      ->config('adsense_revenue_sharing_basic.settings');
    $form['help'] = [
      '#type' => 'details',
      '#open' => FALSE,
      '#title' => $this
        ->t('Help and instructions'),
    ];
    $form['help']['help'] = [
      '#markup' => adsense_revenue_sharing_basic_help_text(),
    ];
    $form['required'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Required parameters'),
    ];
    $form['required']['client_id_profile_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Google AdSense client ID profile field'),
      '#default_value' => $config
        ->get('client_id_profile_field'),
      '#options' => $this
        ->getProfileFields(),
      '#required' => TRUE,
      '#description' => $this
        ->t('This is the user profile field that holds the AdSense Client ID for the site owner as well as (optionally) for site users who participate in revenue sharing.'),
    ];
    $form['percentage'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Revenue sharing percentage'),
    ];
    $form['percentage']['percentage_author'] = [
      '#type' => 'range',
      '#title' => $this
        ->t('Percentage of node views going to author'),
      '#default_value' => $config
        ->get('percentage_author'),
    ];
    $form['percentage']['role'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Percentage of node views going to author with the following roles'),
      '#description' => $this
        ->t('When the author belongs to one or more roles, the percentage of node views using his AdSense Client ID will be the maximum between the author value and the following settings for each role.'),
    ];
    $roles = Role::loadMultiple();
    unset($roles[RoleInterface::ANONYMOUS_ID]);
    unset($roles[RoleInterface::AUTHENTICATED_ID]);

    /** @var \Drupal\user\Entity\Role $role */
    foreach ($roles as $rid => $role) {

      // When using dots in the key, the form values were empty, so use dashes.
      $form['percentage']['role']['percentage_role-' . $rid] = [
        '#type' => 'range',
        '#title' => $role
          ->label(),
        '#default_value' => is_null($config
          ->get('percentage_role.' . $rid)) ? ADSENSE_REVENUE_SHARING_BASIC_PERCENTAGE_ROLE_DEFAULT : $config
          ->get('percentage_role.' . $rid),
      ];
    }
    $form['content_types'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Content types'),
    ];
    $types = NodeType::loadMultiple();

    /** @var \Drupal\node\Entity\NodeType $type */
    foreach ($types as $id => $type) {

      // When using dots in the key, the form values were empty, so use dashes.
      $form['content_types']['node_type-' . $id] = [
        '#type' => 'checkbox',
        '#title' => $type
          ->label(),
        '#default_value' => is_null($config
          ->get('node_type.' . $id)) ? ADSENSE_REVENUE_SHARING_BASIC_NODE_TYPE_DEFAULT : $config
          ->get('node_type.' . $id),
      ];
    }
    $form_state
      ->set([
      '#redirect',
    ], 'admin/config/services/adsense/publisher');
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->configFactory()
      ->getEditable('adsense_revenue_sharing_basic.settings');
    $form_state
      ->cleanValues();
    foreach ($form_state
      ->getValues() as $key => $value) {

      // Replace dashes with dots so that the mapping can be properly set.
      $config
        ->set(str_replace('-', '.', $key), $value);
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * Create the list for the profile field.
   *
   * @return array
   *   array of fields with the field IDs as keys and the field titles as values
   */
  protected function getProfileFields() {
    $profile_list = [];

    // Start with the core fields.

    /** @var \Drupal\Core\Entity\EntityFieldManagerInterface $entityFieldManager */
    $entityFieldManager = \Drupal::service('entity_field.manager');
    $fields = $entityFieldManager
      ->getFieldDefinitions('user', 'user');
    foreach ($fields as $field) {
      if ($field instanceof FieldConfig && $field
        ->getType() == 'string') {

        /** @var \Drupal\field\Entity\FieldConfig $field */
        $profile_list['field:' . $field
          ->getName()] = $field
          ->label();
      }
    }

    // Get fields from the Profile module.
    // @todo adapt this to the profile module.

    /* @codingStandardsIgnoreStart
       if (\Drupal::moduleHandler()->moduleExists('profile')) {
         $result = db_query("SELECT fid, name, title FROM {profile_field} WHERE type='textfield' ORDER BY fid");
         foreach ($result as $row) {
           $profile_list['profile:' . $row->name] = $row->title;
         }
       }
       @codingStandardsIgnoreEnd */
    return $profile_list;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AdsenseRevenueSharingBasicSettings::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
AdsenseRevenueSharingBasicSettings::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AdsenseRevenueSharingBasicSettings::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AdsenseRevenueSharingBasicSettings::getProfileFields protected function Create the list for the profile field.
AdsenseRevenueSharingBasicSettings::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
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.
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.