class SettingsForm in Leaflet MapBox 8

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\leaflet_mapbox\Form\SettingsForm

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'

leaflet_mapbox.routing.yml in ./leaflet_mapbox.routing.yml: leaflet_mapbox.routing.yml

File

src/Form/SettingsForm.php, line 8

Namespace

Drupal\leaflet_mapbox\Form

View source

class SettingsForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('leaflet_mapbox.settings');
    $form['label'] = array(
      '#type' => 'textfield',
      '#title' => t('Map label'),
      '#required' => TRUE,
      '#default_value' => $config
        ->get('label'),
      '#description' => t('Give your map a name, this will be the name shown on the display options form.'),
    );
    $form['api_version'] = array(
      '#type' => 'select',
      '#title' => t('API version'),
      '#required' => TRUE,
      '#default_value' => $config
        ->get('api_version'),
      '#options' => array(
        '3' => t('3 (Mapbox Studio Classic)'),
        '4' => t('4 (Mapbox Studio)'),
      ),
    );
    $form['code'] = array(
      '#type' => 'textfield',
      '#title' => t('Map code'),
      '#default_value' => $config
        ->get('code'),
      '#description' => t('This code is obtained from Mapbox by clicking on the mapbox.js button after publishing your map'),
      '#states' => array(
        'visible' => array(
          ':input[name="api_version"]' => array(
            'value' => '3',
          ),
        ),
        'required' => array(
          ':input[name="api_version"]' => array(
            'value' => '3',
          ),
        ),
      ),
    );
    $form['style_url'] = array(
      '#type' => 'textfield',
      '#title' => t('Style URL'),
      '#default_value' => $config
        ->get('style_url'),
      '#description' => t('Copy and paste the style URL. Example: %url.', array(
        '%url' => 'mapbox://styles/johndoe/erl4zrwto008ob3f2ijepsbszg',
      )),
      '#states' => array(
        'visible' => array(
          ':input[name="api_version"]' => array(
            'value' => '4',
          ),
        ),
        'required' => array(
          ':input[name="api_version"]' => array(
            'value' => '4',
          ),
        ),
      ),
    );
    $form['token'] = array(
      '#type' => 'textfield',
      '#title' => t('Map access token'),
      '#required' => TRUE,
      '#default_value' => $config
        ->get('token'),
      '#description' => t('You will find this in the Mapbox user account settings'),
    );
    $form['zoomlevel'] = array(
      '#type' => 'textfield',
      '#title' => t('Zoom Level'),
      '#required' => TRUE,
      '#default_value' => $config
        ->get('zoomlevel'),
      '#description' => t('You must clear the site caches after changing this value or wait for the caches to expire before this change shows'),
    );
    $form['description'] = array(
      '#type' => 'textarea',
      '#title' => t('Map description'),
      '#default_value' => $config
        ->get('description'),
    );
    return parent::buildForm($form, $form_state);

    // TODO: Change the autogenerated stub
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $values = $form_state
      ->getValues();
    $this
      ->config('leaflet_mapbox.settings')
      ->set('label', $values['label'])
      ->set('api_version', $values['api_version'])
      ->set('code', $values['code'])
      ->set('style_url', $values['style_url'])
      ->set('token', $values['token'])
      ->set('zoomlevel', $values['zoomlevel'])
      ->set('description', $values['description'])
      ->save();
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return array(
      'leaflet_mapbox.settings',
    );
  }

}

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.
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::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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 SettingsForm in Leaflet MapBox 8

Hierarchy

File

Namespace

Members

API Navigation