class WundergroundWeatherSettingsForm in Wunderground weather 8

Defines a form to configure module 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\wunderground_weather\Form\WundergroundWeatherSettingsForm

Expanded class hierarchy of WundergroundWeatherSettingsForm

1 string reference to 'WundergroundWeatherSettingsForm'

wunderground_weather.routing.yml in ./wunderground_weather.routing.yml: wunderground_weather.routing.yml

File

src/Form/WundergroundWeatherSettingsForm.php, line 20: Contains \Drupal\wunderground_weather\Form\wunderground_weatherSettingsForm.

Namespace

Drupal\wunderground_weather\Form

View source

class WundergroundWeatherSettingsForm extends ConfigFormBase {

  /**
   * Defines the interface for a configuration object factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Decorator for the URL generator, which bubbles bubbleable URL metadata.
   *
   * @var \Drupal\Core\Render\MetadataBubblingUrlGenerator
   */
  protected $linkGenerator;

  /**
   * Class responsible for providing language support on language-unaware sites.
   *
   * @var \Drupal\Core\Language\LanguageManager
   */
  private $languageManager;

  /**
   * WundergroundWeatherSettingsForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Defines the interface for a configuration object factory.
   * @param \Drupal\Core\Language\LanguageManager $language_manager
   *   Class for providing language support on language-unaware sites.
   * @param \Drupal\Core\Utility\LinkGenerator $link_generator
   *   Decorator for the URL generator, which bubbles bubbleable URL metadata.
   */
  public function __construct(ConfigFactoryInterface $config_factory, LanguageManager $language_manager, LinkGenerator $link_generator) {
    parent::__construct($config_factory);
    $this
      ->setConfigFactory($config_factory);
    $this->linkGenerator = $link_generator;
    $this->languageManager = $language_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    /** @var \Drupal\Core\Config\ConfigFactoryInterface $config_factory */
    $config_factory = $container
      ->get('config.factory');

    /** @var \Drupal\Core\Language\LanguageManager $language_manager */
    $language_manager = $container
      ->get('language_manager');

    /** @var \Drupal\Core\Utility\LinkGenerator $link_generator */
    $link_generator = $container
      ->get('link_generator');
    return new static($config_factory, $language_manager, $link_generator);
  }

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

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

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

    // Get all settings.
    $config = $this->configFactory
      ->get('wunderground_weather.settings');
    $form['settings'] = [
      '#tree' => TRUE,
    ];

    // Link to get the api key.
    $api_url = 'http://www.wunderground.com/weather/api';
    $url = Url::fromUri($api_url);
    $wg_link = $this->linkGenerator
      ->generate($api_url, $url);
    $form['api_key'] = [
      '#type' => 'textfield',
      '#title' => t('Wunderground API key'),
      '#description' => t('Get your API key at @url', [
        '@url' => $wg_link,
      ]),
      '#default_value' => $config
        ->get('api_key'),
      '#required' => TRUE,
    ];
    $form['language'] = [
      '#type' => 'select',
      '#title' => t('Language'),
      '#options' => $this
        ->getLanguages(),
      '#default_value' => $config
        ->get('language'),
    ];
    return parent::buildForm($form, $form_state);
  }

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

  /**
   * Get the languages used on the current site.
   *
   * @return array
   *   An array of languages to be used in a select element.
   */
  protected function getLanguages() {
    $languages = $this->languageManager
      ->getLanguages();
    $options_array = [];

    /** @var \Drupal\Core\Language\Language $language */
    foreach ($languages as $language) {
      $options_array[$language
        ->getId()] = $language
        ->getName();
    }
    return $options_array;
  }

}

Members

Name	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::$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::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.
WundergroundWeatherSettingsForm::$configFactory	protected	property	Defines the interface for a configuration object factory. Overrides FormBase::$configFactory
WundergroundWeatherSettingsForm::$languageManager	private	property	Class responsible for providing language support on language-unaware sites.
WundergroundWeatherSettingsForm::$linkGenerator	protected	property	Decorator for the URL generator, which bubbles bubbleable URL metadata. Overrides LinkGeneratorTrait::$linkGenerator
WundergroundWeatherSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
WundergroundWeatherSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
WundergroundWeatherSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
WundergroundWeatherSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
WundergroundWeatherSettingsForm::getLanguages	protected	function	Get the languages used on the current site.
WundergroundWeatherSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
WundergroundWeatherSettingsForm::__construct	public	function	WundergroundWeatherSettingsForm constructor. Overrides ConfigFormBase::__construct

You are here

class WundergroundWeatherSettingsForm in Wunderground weather 8

Hierarchy

File

Namespace

Members

API Navigation