You are here

Home » API reference » IP Anonymize 8 » IpAnonSettings.php

class IpAnonSettings in IP Anonymize 8

Settings form for ip_anon module.

Hierarchy

Expanded class hierarchy of IpAnonSettings

1 string reference to 'IpAnonSettings'
ip_anon.routing.yml in ./ip_anon.routing.yml
ip_anon.routing.yml

File

src/Form/IpAnonSettings.php, line 17

Namespace

Drupal\ip_anon\Form
View source 
class IpAnonSettings extends ConfigFormBase {

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * Constructs an IpAnonSettings object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, Connection $connection, DateFormatterInterface $date_formatter) {
    parent::__construct($config_factory);
    $this->connection = $connection;
    $this->dateFormatter = $date_formatter;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('ip_anon.settings');
    $config
      ->set('policy', $form_state
      ->getValue('policy'));
    foreach (Element::children($form['period']) as $variable) {
      $config
        ->set($variable, $form_state
        ->getValue($variable));
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('ip_anon.settings');
    $form['policy'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Retention policy'),
      '#options' => [
        $this
          ->t('Preserve IP addresses'),
        $this
          ->t('Anonymize IP addresses'),
      ],
      '#description' => $this
        ->t('This setting may be used to temporarily disable IP anonymization.'),
      '#default_value' => $config
        ->get('policy'),
    ];
    $form['period'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Retention period'),
      '#description' => $this
        ->t('IP addresses older than the retention period will be anonymized.'),
    ];
    $intervals = [
      0,
      30,
      60,
      120,
      180,
      300,
      600,
      900,
      1800,
      2700,
      3600,
      5400,
      7200,
      10800,
      21600,
      32400,
      43200,
      64800,
      86400,
      172800,
      259200,
      345600,
      604800,
      1209600,
      2419200,
      4838400,
      9676800,
      31536000,
      2147483647,
    ];
    $options = array_combine($intervals, array_map([
      $this->dateFormatter,
      'formatInterval',
    ], $intervals));
    module_load_include('inc', 'ip_anon');
    foreach (ip_anon_tables() as $table => $columns) {
      $form['period']["period_{$table}"] = [
        '#type' => 'select',
        '#title' => $this
          ->t('@table table', [
          '@table' => $table,
        ]),
        '#options' => $options,
        '#default_value' => $config
          ->get("period_{$table}"),
        '#description' => new FormattableMarkup('@description', [
          '@description' => $this
            ->getTableDescription($table),
        ]),
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * Returns table description.
   */
  public function getTableDescription($table) {
    if ($table == 'sessions') {
      return drupal_get_module_schema('system', 'sessions')['description'];
    }
    elseif (method_exists($this->connection
      ->schema(), 'getComment')) {
      return $this->connection
        ->schema()
        ->getComment($table);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
IpAnonSettings::$connection protected property The database connection.
IpAnonSettings::$dateFormatter protected property The date formatter service.
IpAnonSettings::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
IpAnonSettings::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
IpAnonSettings::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
IpAnonSettings::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
IpAnonSettings::getTableDescription public function Returns table description.
IpAnonSettings::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
IpAnonSettings::__construct public function Constructs an IpAnonSettings object. Overrides ConfigFormBase::__construct
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.