You are here

Home » API reference » Viewport 8 » ViewportSettingsForm.php

class ViewportSettingsForm in Viewport 8

Class to configure viewport settings for this site.

Hierarchy

Expanded class hierarchy of ViewportSettingsForm

1 string reference to 'ViewportSettingsForm'
viewport.routing.yml in ./viewport.routing.yml
viewport.routing.yml

File

src/Form/ViewportSettingsForm.php, line 12

Namespace

Drupal\viewport\Form
View source 
class ViewportSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $viewportSettings = $this
      ->configFactory()
      ->get('viewport.settings');
    $form['viewport'] = array(
      '#type' => 'fieldset',
    );
    $form['viewport']['width'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Width'),
      '#default_value' => $viewportSettings
        ->get('width'),
      '#description' => $this
        ->t('You probably want this to be %device-width, but a fixed number of pixels (only the number) is accepted too.', array(
        '%device-width' => 'device-width',
      )),
    );
    $form['viewport']['height'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Height'),
      '#default_value' => $viewportSettings
        ->get('height'),
      '#description' => $this
        ->t('%device-height, or a fixed number of pixels (only the number).', array(
        '%device-height' => 'device-height',
      )),
    );
    $form['viewport']['initial_scale'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Initial Scale'),
      '#default_value' => $viewportSettings
        ->get('initial_scale'),
      '#description' => $this
        ->t('Any value in the range (0, 10.0]. Usually this is set to 1.0'),
    );
    $form['viewport']['minimum_scale'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Minimum Scale'),
      '#default_value' => $viewportSettings
        ->get('minimum_scale'),
      '#description' => $this
        ->t('Any value in the range (0, 10.0]. Usually this is set to the same value as the %initial-scale property', array(
        '%initial-scale' => 'initial-scale',
      )),
    );
    $form['viewport']['maximum_scale'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Maximum Scale'),
      '#default_value' => $viewportSettings
        ->get('maximum_scale'),
      '#description' => $this
        ->t('Any value in the range (0, 10.0]. Usually this is set to 1.0'),
    );
    $form['viewport']['user_scalable'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('User Scalable'),
      '#default_value' => $viewportSettings
        ->get('user_scalable'),
    );
    $form['viewport']['selected_pages'] = array(
      '#type' => 'textarea',
      '#title' => $this
        ->t('Selected pages'),
      '#default_value' => $viewportSettings
        ->get('selected_pages'),
      '#description' => $this
        ->t("The viewport settings will be applied to the following paths. <br/>\n        Specify pages by using their paths. Enter one path per line. The '*' character is a wildcard.\n        Example paths are %node for the first node of the site and %node-wildcard for every node.\n        %front is the front page.<br>\n        Note in Drupal 8 paths are preceded by a forward slash %slash.", array(
        '%node' => '/node',
        '%node-wildcard' => '/node*',
        '%front' => '<front>',
        '%slash' => '"/"',
      )),
    );
    return parent::buildForm($form, $form_state);
  }

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

    // Basic validation on viewport values to assure they're entered properly.
    foreach ($form_state
      ->getValues() as $key => $value) {

      // User_scalable is a checkbox, no need to check for commas.
      if (in_array($key, Element::children($form['viewport'])) && $key != 'user_scalable') {
        if (strstr($value, ',')) {
          $form_state
            ->setErrorByName($key, $this
            ->t('Commas are not allowed for the %field_name field.
            Please, ensure you are using dots (".") when entering decimal values,
            and avoid any commas after the values', array(
            '%field_name' => $form['viewport'][$key]['#title'],
          )));
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $viewportSettings = $this
      ->configFactory()
      ->getEditable('viewport.settings');

    // Store submitted values.
    foreach ($form_state
      ->getValues() as $key => $value) {
      if (in_array($key, Element::children($form['viewport']))) {

        // Make sure user_scalable is treated as a boolean.
        $value = $key == 'user_scalable' ? (bool) $value : $value;
        $viewportSettings
          ->set($key, $value);
      }
    }
    $viewportSettings
      ->save();
  }

}

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.
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.
ViewportSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
ViewportSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ViewportSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ViewportSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
ViewportSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm