You are here

Home » API reference » Yandex.Metrics 8.3 » YandexMetricsCounterSettingsForm.php

class YandexMetricsCounterSettingsForm in Yandex.Metrics 8.3

Same name and namespace in other branches
  1. 8.2 src/Form/YandexMetricsCounterSettingsForm.php \Drupal\yandex_metrics\Form\YandexMetricsCounterSettingsForm

Provides a form for configuring Yandex.Metrics counter settings.

Hierarchy

Expanded class hierarchy of YandexMetricsCounterSettingsForm

1 string reference to 'YandexMetricsCounterSettingsForm'
yandex_metrics.routing.yml in ./yandex_metrics.routing.yml
yandex_metrics.routing.yml

File

src/Form/YandexMetricsCounterSettingsForm.php, line 15
Contains \Drupal\yandex_metrics\Form\YandexMetricsCounterSettingsForm.

Namespace

Drupal\yandex_metrics\Form
View source 
class YandexMetricsCounterSettingsForm extends ConfigFormBase {

  /**
   * Implements \Drupal\Core\Form\FormInterface::getFormID().
   */
  public function getFormID() {
    return 'yandex_metrics_counter_settings';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return array(
      'yandex_metrics.settings',
    );
  }

  /**
   * Implements \Drupal\Core\Form\FormInterface::buildForm().
   */
  public function buildForm(array $form, FormStateInterface $form_state, $action = NULL) {

    // Create config object.
    $config = \Drupal::config('yandex_metrics.settings');
    $form['counter_code'] = array(
      '#default_value' => $config
        ->get('counter_code'),
      '#title' => $this
        ->t('Counter Code'),
      '#type' => 'textarea',
      '#rows' => 10,
      '#description' => $this
        ->t('Paste Yandex.Metrics counter code for your site here.'),
    );
    $form['path'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Page specific tracking settings'),
      '#collapsed' => TRUE,
    );
    $visibility = $config
      ->get('visibility.path.visibility');
    $options = array(
      $this
        ->t('Add to every page except the listed pages.'),
      $this
        ->t('Add to the listed pages only.'),
    );
    $form['path']['visibility'] = array(
      '#type' => 'radios',
      '#title' => $this
        ->t('Add code to specific pages'),
      '#options' => $options,
      '#default_value' => $visibility,
    );
    $pages = $config
      ->get('visibility.path.pages');
    $description = $this
      ->t("Enter one page per line as Drupal paths. The '*' character is a wildcard. Example paths are %blog for the blog page and %blog-wildcard for every personal blog. %front is the front page.", array(
      '%blog' => 'blog',
      '%blog-wildcard' => 'blog/*',
      '%front' => '<front>',
    ));
    $form['path']['pages'] = array(
      '#type' => 'textarea',
      '#title' => $this
        ->t('Pages'),
      '#default_value' => $pages,
      '#description' => $description,
      '#wysiwyg' => FALSE,
      '#rows' => 10,
    );

    // Render the role overview.
    $form['role'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Role specific tracking settings'),
      '#collapsed' => TRUE,
    );
    $form['role']['visibility_roles'] = array(
      '#type' => 'radios',
      '#title' => $this
        ->t('Add tracking for specific roles'),
      '#options' => array(
        $this
          ->t('Add to the selected roles only'),
        $this
          ->t('Add to every role except the selected ones'),
      ),
      '#default_value' => $config
        ->get('visibility.role.visibility'),
    );
    $role_options = array_map('\\Drupal\\Component\\Utility\\Html::escape', user_role_names());
    $form['role']['roles'] = array(
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Roles'),
      '#default_value' => $config
        ->get('visibility.role.roles'),
      '#options' => $role_options,
      '#description' => $this
        ->t('If none of the roles are selected, all users will be tracked. If a user has any of the roles checked, that user will be tracked (or excluded, depending on the setting above).'),
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * Implements \Drupal\Core\Form\FormInterface::validateForm().
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
  }

  /**
   * Implements \Drupal\Core\Form\FormInterface::submitForm().
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Create config object.
    $config = $this->configFactory
      ->getEditable('yandex_metrics.settings');
    $counter_code = $form_state
      ->getValue('counter_code');
    $visibility = $form_state
      ->getValue('visibility');
    $pages = $form_state
      ->getValue('pages');
    $visibility_roles = $form_state
      ->getValue('visibility_roles');
    $roles = $form_state
      ->getValue('roles');
    $config
      ->set('counter_code', $counter_code)
      ->set('visibility.path.visibility', $visibility)
      ->set('visibility.path.pages', $pages)
      ->set('visibility.role.visibility', $visibility_roles)
      ->set('visibility.role.roles', $roles)
      ->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.
FormInterface::getFormId public function Returns a unique string identifying the form. 236
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.
YandexMetricsCounterSettingsForm::buildForm public function Implements \Drupal\Core\Form\FormInterface::buildForm(). Overrides ConfigFormBase::buildForm
YandexMetricsCounterSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
YandexMetricsCounterSettingsForm::getFormID public function Implements \Drupal\Core\Form\FormInterface::getFormID().
YandexMetricsCounterSettingsForm::submitForm public function Implements \Drupal\Core\Form\FormInterface::submitForm(). Overrides ConfigFormBase::submitForm
YandexMetricsCounterSettingsForm::validateForm public function Implements \Drupal\Core\Form\FormInterface::validateForm(). Overrides FormBase::validateForm