You are here

Home » API reference » Progressive Web App 8 » PwaExtrasSettingsForm.php

class PwaExtrasSettingsForm in Progressive Web App 8

Same name and namespace in other branches
  1. 2.x modules/pwa_extras/src/Form/PwaExtrasSettingsForm.php \Drupal\pwa_extras\Form\PwaExtrasSettingsForm

PWA Extras admin settings form.

Hierarchy

Expanded class hierarchy of PwaExtrasSettingsForm

1 string reference to 'PwaExtrasSettingsForm'
pwa_extras.routing.yml in modules/pwa_extras/pwa_extras.routing.yml
modules/pwa_extras/pwa_extras.routing.yml

File

modules/pwa_extras/src/Form/PwaExtrasSettingsForm.php, line 11

Namespace

Drupal\pwa_extras\Form
View source 
class PwaExtrasSettingsForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('pwa_extras.settings.apple');
    $form['apple'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Apple/IOS Specific Settings'),
      '#open' => TRUE,
    ];
    $mask_color = $config
      ->get('mask_color') ?: '#0678be';
    $form['apple']['touch_icons'] = [
      "#type" => 'checkboxes',
      "#title" => $this
        ->t('Touch Icons'),
      "#options" => str_replace('<', '&lt;', pwa_extras_apple_touch_icons($mask_color)),
      '#default_value' => $config
        ->get('touch_icons'),
    ];
    $form['apple']['mask_color'] = [
      "#type" => 'color',
      "#title" => $this
        ->t('Mask icon color'),
      "#description" => $this
        ->t('The color scheme of OS pinned tab mask icon.'),
      '#default_value' => $mask_color,
      '#states' => [
        'invisible' => [
          ':input[value="touch-icon-mask"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $site_name = $this
      ->config('pwa.config')
      ->get('site_name') ?: $this
      ->config('system.site')
      ->get('name');
    $color_select = $config
      ->get('color_select') ?: 'default';
    $form['apple']['meta_tags'] = [
      "#type" => 'checkboxes',
      "#title" => $this
        ->t('Meta Tags'),
      "#options" => str_replace('<', '&lt;', pwa_extras_apple_meta_tags($site_name, $color_select)),
      '#default_value' => $config
        ->get('meta_tags'),
    ];
    $form['apple']['color_select'] = [
      "#type" => 'select',
      "#title" => $this
        ->t('Select color for status-bar-style'),
      '#options' => [
        'default' => $this
          ->t('Default'),
        'black' => $this
          ->t('Black'),
        'black_translucent' => $this
          ->t('Black-translucent'),
      ],
      '#states' => [
        'invisible' => [
          ':input[value="meta-status-bar-style"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
      '#default_value' => $color_select,
    ];
    $form['apple']['home_screen_icons'] = [
      "#type" => 'checkboxes',
      "#title" => $this
        ->t('Add to homescreen icons'),
      "#options" => str_replace('<', '&lt;', pwa_extras_apple_home_screen_icons()),
      '#default_value' => $config
        ->get('home_screen_icons'),
    ];
    return parent::buildForm($form, $form_state);
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('pwa_extras.settings.apple');
    $values = $form_state
      ->getValues();
    $config
      ->set('touch_icons', $values['touch_icons'])
      ->set('mask_color', $values['mask_color'])
      ->set('meta_tags', $values['meta_tags'])
      ->set('color_select', $values['color_select'])
      ->set('home_screen_icons', $values['home_screen_icons'])
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * @return config settings.
   */
  protected function getEditableConfigNames() {
    return [
      'pwa_extras.settings.apple',
    ];
  }

}

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.
PwaExtrasSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
PwaExtrasSettingsForm::getEditableConfigNames protected function Overrides ConfigFormBaseTrait::getEditableConfigNames
PwaExtrasSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PwaExtrasSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
PwaExtrasSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.