class NodeStatisticsSettingsForm in Open Social 8.4

Configure social profile settings.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\social_node_statistics\Form\NodeStatisticsSettingsForm

1 string reference to 'NodeStatisticsSettingsForm'

social_node_statistics.routing.yml in modules/custom/social_node_statistics/social_node_statistics.routing.yml

modules/custom/social_node_statistics/social_node_statistics.routing.yml

File

modules/custom/social_node_statistics/src/Form/NodeStatisticsSettingsForm.php, line 12

Namespace

Drupal\social_node_statistics\Form

class NodeStatisticsSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $options = [];

    /** @var \Drupal\node\Entity\NodeType $node_type */
    foreach (NodeType::loadMultiple() as $node_type) {
      $options[$node_type
        ->id()] = $node_type
        ->label();
    }

    // List of node types.
    $form['node_types'] = [
      '#type' => 'checkboxes',
      '#options' => $options,
      '#title' => $this
        ->t('Track views for node types'),
      '#description' => $this
        ->t('Select which node types views should be tracked for.'),
      '#default_value' => $this
        ->config('social_node_statistics.settings')
        ->get('node_types'),
    ];

    // Max age of caching.
    $form['max_age'] = [
      '#type' => 'select',
      '#options' => [
        30 => $this
          ->t('30 seconds'),
        60 => $this
          ->t('1 minute'),
        120 => $this
          ->t('2 minutes'),
        300 => $this
          ->t('5 minutes'),
        600 => $this
          ->t('10 minutes'),
        900 => $this
          ->t('15 minutes'),
        1800 => $this
          ->t('30 minutes'),
        3600 => $this
          ->t('1 hour'),
        21600 => $this
          ->t('6 hours'),
        43200 => $this
          ->t('12 hours'),
        86400 => $this
          ->t('1 day'),
      ],
      '#title' => $this
        ->t('Max age of views count caching'),
      '#description' => $this
        ->t('Select how long before the views count cache on a node display is invalidated.'),
      '#default_value' => $this
        ->config('social_node_statistics.settings')
        ->get('max_age'),
      '#required' => TRUE,
      '#access' => $this
        ->currentUser()
        ->hasPermission('administer node statistics caching'),
    ];

    // Minimum number of views.
    $form['min_views'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Minimum number of new views before cache invalidation'),
      '#description' => $this
        ->t('Set the minimum number of new views before the views count cache on a node display is invalidated.'),
      '#default_value' => $this
        ->config('social_node_statistics.settings')
        ->get('min_views'),
      '#min' => 0,
      '#step' => 1,
      '#required' => TRUE,
      '#access' => $this
        ->currentUser()
        ->hasPermission('administer node statistics caching'),
    ];
    return parent::buildForm($form, $form_state);
  }

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

    // Filter out unchecked items.
    $node_types = $form_state
      ->getValue('node_types');
    foreach ($node_types as $node_type => $value) {
      if (!$value) {
        unset($node_types[$node_type]);
      }
    }

    // Save config.
    $config = $this
      ->config('social_node_statistics.settings');
    $config
      ->set('node_types', $node_types)
      ->set('max_age', $form_state
      ->getValue('max_age'))
      ->set('min_views', $form_state
      ->getValue('min_views'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	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.
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.
NodeStatisticsSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
NodeStatisticsSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
NodeStatisticsSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
NodeStatisticsSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.