You are here

Home » API reference » Access unpublished 8 » SettingsForm.php

class SettingsForm in Access unpublished 8

Configure access unpublished settings for this site.

Hierarchy

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'
access_unpublished.routing.yml in ./access_unpublished.routing.yml
access_unpublished.routing.yml

File

src/Form/SettingsForm.php, line 12

Namespace

Drupal\access_unpublished\Form
View source 
class SettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('access_unpublished.settings');
    $form['hash_key'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Hash key'),
      '#default_value' => $config
        ->get('hash_key'),
      '#size' => 60,
      '#maxlength' => 128,
      '#required' => TRUE,
    ];
    $form['duration'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Lifetime'),
      '#description' => $this
        ->t('Default lifetime of the generated access tokens.'),
      '#options' => AccessUnpublishedForm::getDurationOptions(),
      '#default_value' => $config
        ->get('duration'),
    ];
    $form['cleanup_expired_tokens'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Cleanup expired tokens'),
      '#description' => $this
        ->t('Cron will cleanup expired tokens.'),
      '#default_value' => $config
        ->get('cleanup_expired_tokens'),
    ];
    $form['cleanup_expired_tokens_period'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Period of time for cron cleanup.'),
      '#default_value' => $config
        ->get('cleanup_expired_tokens_period'),
      '#description' => $this
        ->t("Describe a time by reference to the current day, like '-90 days' (All tokens which expired more than 90 days ago). See <a href=\"http://php.net/manual/function.strtotime.php\">strtotime</a> for more details."),
      '#size' => 60,
      '#maxlength' => 128,
      '#states' => [
        'visible' => [
          ':input[name="cleanup_expired_tokens"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['modify_http_headers'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Modify HTTP Headers on unpublished page.'),
      '#default_value' => $this
        ->prepareHeadersDisplay(),
      '#description' => $this
        ->t("Enter one header per line, in the format key|label."),
      '#element_validate' => [
        [
          ListItemBase::class,
          'validateAllowedValues',
        ],
      ],
      '#field_has_data' => FALSE,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->config('access_unpublished.settings')
      ->set('hash_key', $form_state
      ->getValue('hash_key'))
      ->set('duration', $form_state
      ->getValue('duration'))
      ->set('cleanup_expired_tokens', $form_state
      ->getValue('cleanup_expired_tokens'))
      ->set('cleanup_expired_tokens_period', $form_state
      ->getValue('cleanup_expired_tokens_period'))
      ->set('modify_http_headers', $form_state
      ->getValue('modify_http_headers'))
      ->save();
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $strtotime = @strtotime($form_state
      ->getValue('cleanup_expired_tokens_period'));
    if (!$strtotime) {
      $form_state
        ->setErrorByName('cleanup_expired_tokens_period', $this
        ->t('The relative start date value entered is invalid.'));
    }
    elseif ($strtotime > time()) {
      $form_state
        ->setErrorByName('cleanup_expired_tokens_period', $this
        ->t('The value has to be negative.'));
    }
  }

  /**
   * Format array to display on settings form.
   *
   * @return string
   *   Return string of HTTP headers.
   */
  private function prepareHeadersDisplay() {
    $headers = $this
      ->config('access_unpublished.settings')
      ->get('modify_http_headers');
    $lines = [];
    foreach ($headers as $key => $value) {
      $lines[] = "{$key}|{$value}";
    }
    return implode("\n", $lines);
  }

}

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.
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.
SettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::prepareHeadersDisplay private function Format array to display on settings form.
SettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.