You are here

Home » API reference » Security.txt 8 » SecuritytxtSignForm.php

class SecuritytxtSignForm in Security.txt 8

Upload the security.txt.sig file.

Hierarchy

Expanded class hierarchy of SecuritytxtSignForm

1 string reference to 'SecuritytxtSignForm'
securitytxt.routing.yml in ./securitytxt.routing.yml
securitytxt.routing.yml

File

src/Form/SecuritytxtSignForm.php, line 14

Namespace

Drupal\securitytxt\Form
View source 
class SecuritytxtSignForm extends ConfigFormBase {

  /**
   * A 'securitytxt.settings' config instance.
   *
   * @var \Drupal\Core\Config\ImmutableConfig
   */
  protected $settings;

  /**
   * Constructs a SecuritytxtSignForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   */
  public function __construct(ConfigFactoryInterface $config_factory) {
    parent::__construct($config_factory);
    $this->settings = $config_factory
      ->getEditable('securitytxt.settings');
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $enabled = $this->settings
      ->get('enabled');
    if (!$enabled) {
      $form['instructions'] = [
        '#type' => 'markup',
        '#markup' => '<p>' . $this
          ->t('You must <a href=":configure">configure and enable</a> your security.txt file before you can sign it.', [
          ':configure' => Url::fromRoute('securitytxt.configure')
            ->toString(),
        ]) . '</p>',
      ];
      return $form;
    }
    $form['instructions'] = [
      '#type' => 'markup',
      '#markup' => '<ol>' . '<li>' . $this
        ->t('<a href=":download" download="security.txt">Download</a> your security.txt file.', [
        ':download' => Url::fromRoute('securitytxt.securitytxt_file')
          ->toString(),
      ]) . '</li>' . '<li><p>Sign your security.txt file with the encryption key you specified in your security.txt file. This can be done with the following GPG command:</p><p><kbd>gpg -u KEYID --output security.txt.sig  --armor --detach-sig security.txt</kbd></p></li>' . '<li>Paste the contents of the <kbd>security.txt.sig</kbd> file into the text box below.</li>' . '</ol>',
    ];
    $form['signature_text'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Signature'),
      '#default_value' => $this->settings
        ->get('signature_text'),
      '#rows' => 20,
    ];
    return parent::buildForm($form, $form_state);
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->settings
      ->set('signature_text', $form_state
      ->getValue('signature_text'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

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.
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.
SecuritytxtSignForm::$settings protected property A 'securitytxt.settings' config instance.
SecuritytxtSignForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SecuritytxtSignForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SecuritytxtSignForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SecuritytxtSignForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SecuritytxtSignForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SecuritytxtSignForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
SecuritytxtSignForm::__construct public function Constructs a SecuritytxtSignForm object. Overrides ConfigFormBase::__construct
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.