class HumansTxtAdminSettingsForm in Humans.txt 8

Same name and namespace in other branches

2.x src/Form/HumansTxtAdminSettingsForm.php \Drupal\humanstxt\Form\HumansTxtAdminSettingsForm

Class HumanstxtAdminSettingsForm implements the Humanstxt Settings Form.

@package Drupal\humanstxt\Form @access public

View source

class HumansTxtAdminSettingsForm extends ConfigFormBase {

  /**
   * Getter method for Form ID.
   *
   * The form ID is used in implementations of hook_form_alter() to allow other
   * modules to alter the render array built by this form controller. It must be
   * unique site wide. It normally starts with the providing module's name.
   *
   * @return string
   *   The unique ID of the form defined by this class.
   */
  public function getFormId() {
    return 'humanstxt_admin_settings';
  }

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

  /**
   * Build the Humans.txt Config form.
   *
   * A build form method constructs an array that defines how markup and
   * other form elements are included in an HTML form.
   *
   * @param array $form
   *   Default form array structure.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Object containing current form state.
   *
   * @return array
   *   The render array defining the elements of the form.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Getting the config default values.
    // Always last values or initial by default if post install.
    $config = $this
      ->config('humanstxt.settings');
    $content = $config
      ->get('content');
    $display_link = $config
      ->get('display_link');

    // Building the Form.
    $form['humanstxt_about'] = [
      '#type' => 'item',
      '#markup' => $this
        ->t('Add here the information about the different
                   people who have contributed to building the website, you can
                   find more info in <a href="@humanstxt">humanstxt.org</a> and
                   use <a href="@humanstxt_file">this file</a> as base file.', [
        '@humanstxt' => 'http://humanstxt.org',
        '@humanstxt_file' => 'http://humanstxt.org/humans.txt',
      ]),
    ];
    $form['humanstxt_content'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Content of Humans.txt'),
      '#description' => $this
        ->t('Fill the area following the pattern.'),
      '#default_value' => $content,
      '#cols' => 60,
      '#rows' => 20,
      '#wysiwyg' => FALSE,
    ];
    $form['humanstxt_display_link'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Insert link to Humans.txt file'),
      '#description' => $this
        ->t('By activating this field you will make
                        Humans.txt file linked from the head section of the
                        HTML code.'),
      '#default_value' => $display_link,
    ];
    return parent::buildForm($form, $form_state);
  }

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

    // Get the values from the form state.
    $content_submit = $form_state
      ->getValue('humanstxt_content');
    $display_link_submit = $form_state
      ->getValue('humanstxt_display_link');

    // Set the new values in the config object of the module.
    $this
      ->config('humanstxt.settings')
      ->set('content', $content_submit)
      ->set('display_link', $display_link_submit)
      ->save();

    // Delete former cache tags.
    Cache::invalidateTags([
      'humanstxt',
    ]);
    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
HumansTxtAdminSettingsForm::buildForm	public	function	Build the Humans.txt Config form. Overrides ConfigFormBase::buildForm
HumansTxtAdminSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
HumansTxtAdminSettingsForm::getFormId	public	function	Getter method for Form ID. Overrides FormInterface::getFormId
HumansTxtAdminSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.

You are here

class HumansTxtAdminSettingsForm in Humans.txt 8

Hierarchy

See also

File

Namespace

Members

API Navigation