You are here

Home » API reference » Browscap 8.3 » BrowscapAdmin.php

class BrowscapAdmin in Browscap 8.3

Defines Browscap administration form.

Hierarchy

Expanded class hierarchy of BrowscapAdmin

1 string reference to 'BrowscapAdmin'
browscap.routing.yml in ./browscap.routing.yml
browscap.routing.yml

File

src/Form/BrowscapAdmin.php, line 13

Namespace

Drupal\browscap\Form
View source 
class BrowscapAdmin extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = \Drupal::config('browscap.settings');
    $form = [];

    // Check the local browscap data version number.
    $version = $config
      ->get('version');

    // If the version number is 0 then browscap data has never been fetched.
    if ($version == 0) {
      $version = $this
        ->t('Never fetched');
    }
    $form['data'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('User agent detection settings'),
    ];
    $form['data']['browscap_data_version'] = [
      '#markup' => '<p>' . $this
        ->t('Current browscap data version: %fileversion.', [
        '%fileversion' => $version,
      ]) . '</p>',
    ];
    $form['data']['browscap_enable_automatic_updates'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable automatic updates'),
      '#default_value' => $config
        ->get('enable_automatic_updates'),
      '#description' => $this
        ->t('Automatically update the user agent detection information.'),
    ];
    $options = [
      3600,
      10800,
      21600,
      32400,
      43200,
      86400,
      172800,
      259200,
      604800,
      1209600,
      2419200,
      4838400,
      9676800,
    ];
    $dateformatter = \Drupal::service('date.formatter');
    $form['data']['browscap_automatic_updates_timer'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Check for new user agent detection information every'),
      '#default_value' => $config
        ->get('automatic_updates_timer'),
      '#options' => array_map([
        $dateformatter,
        'formatInterval',
      ], array_combine($options, $options)),
      '#description' => $this
        ->t('Newer user agent detection information will be automatically downloaded and installed. (Requires a correctly configured @cron_link).', [
        '@cron_link' => \Drupal::l("cron maintenance task", Url::fromRoute('system.status')),
      ]),
      '#states' => [
        'visible' => [
          ':input[name="browscap_enable_automatic_updates"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['data']['browscap_version_url'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Browscap version URL'),
      '#default_value' => $config
        ->get('version_url'),
      '#description' => $this
        ->t('The URL to the information about the current Browscap version available.'),
    ];
    $form['data']['browscap_data_url'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Browscap data URL'),
      '#default_value' => $config
        ->get('data_url'),
      '#description' => $this
        ->t('The URL to Browscap data.'),
    ];
    $form['actions']['browscap_refresh'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Refresh browscap data'),
      '#submit' => [
        '::refreshSubmit',
      ],
      '#weight' => 10,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('browscap.settings')
      ->set('automatic_updates_timer', $form_state
      ->getValue('browscap_automatic_updates_timer'))
      ->set('enable_automatic_updates', $form_state
      ->getValue('browscap_enable_automatic_updates'))
      ->set('data_url', $form_state
      ->getValue('browscap_data_url'))
      ->set('version_url', $form_state
      ->getValue('browscap_version_url'))
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * Submit callback for the 'Refresh browscap data' submit.
   *
   * Performs an import then records when it completed.
   */
  public function refreshSubmit(array &$form, FormStateInterface $form_state) {

    // Update the browscap information.
    $endpoint = new BrowscapEndpoint();
    \Drupal::service('browscap.importer')
      ->import($endpoint, FALSE);

    // Record when the browscap information was updated.
    $this
      ->config('browscap.settings')
      ->set('imported', REQUEST_TIME)
      ->save();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BrowscapAdmin::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
BrowscapAdmin::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
BrowscapAdmin::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
BrowscapAdmin::refreshSubmit public function Submit callback for the 'Refresh browscap data' submit.
BrowscapAdmin::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
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.
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.