You are here

Home » API reference » Icon API 8 » IconBundleOverviewForm.php

class IconBundleOverviewForm in Icon API 8

Configure file system settings for this site.

Hierarchy

Expanded class hierarchy of IconBundleOverviewForm

1 string reference to 'IconBundleOverviewForm'
icon.routing.yml in ./icon.routing.yml
icon.routing.yml

File

src/Form/IconBundleOverviewForm.php, line 11

Namespace

Drupal\icon\Form
View source 
class IconBundleOverviewForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('icon.overview');

    // Attach UI fonts for Icon API.
    //    $module_path = drupal_get_path('module', 'icon');
    //    $form['#attached'] = array(
    //        'css' => array(
    //            $module_path . '/css/icon.admin.css',
    //            $module_path . '/css/iconapi-embedded.css',
    //            array(
    //                'type' => 'file',
    //                'data' => $module_path . '/css/iconapi-ie7.css',
    //                'browser' => array(
    //                    '!IE' => FALSE,
    //                    'IE' => 'IE 7',
    //                ),
    //            ),
    //        ),
    //    );
    // Determine access to elements based on user permissions.
    $admin = \Drupal::currentUser()
      ->hasPermission('administer icons');
    $form['bundles'] = array(
      '#tree' => TRUE,
    );
    foreach (icon_bundles(NULL, TRUE) as $bundle) {
      if (!$admin && !$bundle['status'] || !$bundle['name']) {
        continue;
      }
      $form['bundles'][$bundle['name']]['#bundle'] = $bundle;
      $form['bundles'][$bundle['name']]['status'] = array(
        '#access' => $admin,
        '#type' => 'checkbox',
        '#title' => $bundle['title'] ? $bundle['title'] : $bundle['name'],
        '#default_value' => $bundle['status'],
      );
    }
    $form['global'] = array(
      '#access' => $admin,
      '#type' => 'fieldset',
      '#title' => t('Global Settings'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    );
    $view_path = \Drupal::config('icon.settings')
      ->get('icon_api_view_path_alias');
    $form['global']['icon_api_view_path_alias'] = array(
      '#type' => 'textfield',
      '#title' => t('View Path'),
      '#field_prefix' => base_path(),
      '#input_group' => TRUE,
      '#description' => t('If provided, users with the "view icons" permission will be able to view enabled icons at this URL (defaults to: <code>:path</code>. Change this url if it conflicts with other paths on your site. Leave empty to disable.', array(
        ':path' => base_path() . 'icons',
      )),
      '#default_value' => $view_path,
    );

    // Show warning message for servers running apache.
    $apache_show_warning = $view_path === 'icons' && strpos(\Drupal\Component\Utility\Unicode::strtolower($_SERVER['SERVER_SOFTWARE']), 'apache') !== FALSE;
    $apache_suppress_warning = \Drupal::config('icon.settings')
      ->get('icon_api_apache_suppress_warning');
    if ($apache_show_warning && !$apache_suppress_warning) {
      drupal_set_message(t('<strong>WARNING:</strong> Apache installations are typically configured with a server level alias that redirects "/icons" to an internal directory on the server. It is highly recommended that this be removed from the configuration file for the view path to work properly. If this modification has been made to the server, you may surpress this messages in the global settings below. The only alternative is to change the view path in the global settings below. See: <a href=":link">:link</a>.', array(
        ':link' => 'https://drupal.org/node/2198427',
      )), 'warning', FALSE);
    }

    // Provide toggle for suppressing warning message.
    $form['global']['icon_api_apache_suppress_warning'] = array(
      '#access' => $apache_show_warning,
      '#type' => 'checkbox',
      '#title' => t('Suppress the Apache server alias warning'),
      '#default_value' => $apache_suppress_warning,
    );
    $form['actions']['#type'] = 'actions';
    $form['actions']['#access'] = $admin;
    $form['actions']['submit'] = array(
      '#type' => 'submit',
      '#value' => $this
        ->t('Save configuration'),
      '#button_type' => 'primary',
    );
    return parent::buildForm($form, $form_state);
  }

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

    // Ensure only authorized users can submit the form.
    if (!\Drupal::currentUser()
      ->hasPermission('administer icons')) {
      form_set_error('', t('You are not authorized to submit this form.'));
    }
    $view_path_alias = $form_state
      ->getValue('icon_api_view_path_alias');

    // @FIXME
    // menu_get_item() has been removed. To retrieve route information, use the
    // RouteMatch object, which you can retrieve by calling \Drupal::routeMatch().
    //
    //
    // @see https://www.drupal.org/node/2203305
    // if ($form['global']['icon_api_view_path_alias']['#default_value'] !== $form_state['values']['icon_api_view_path_alias'] && menu_get_item($view_path_alias)) {
    //     form_set_error('icon_api_view_path_alias', t('The view path alias provided, "%url", is already in use. Please enter a different path.', array(
    //       '%url' => $view_path_alias,
    //     )));
    //   }

    //$form_state->setErrorByName('icon_api_view_path_alias', $this->t('The view path alias provided'));
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $view_path_alias = $form_state
      ->getValue('icon_api_view_path_alias');
    if ($form['global']['icon_api_view_path_alias']['#default_value'] !== $view_path_alias) {
      \Drupal::configFactory()
        ->getEditable('icon.settings')
        ->set('icon_api_view_path_alias', $view_path_alias)
        ->save();
      if (!empty($view_path_alias)) {
        drupal_set_message(t('The view path alias, "%url", has been created for users with the %permission permission.', array(
          '%permission' => 'view icon',
          '%url' => base_path() . $view_path_alias,
        )));
      }
      else {
        drupal_set_message(t('The view path alias is disabled. Icons are now only viewable in the administrative area.'));
      }
      menu_rebuild();
    }
    if ($form_state
      ->getValue('icon_api_apache_suppress_warning')) {
      \Drupal::configFactory()
        ->getEditable('icon.settings')
        ->set('icon_api_apache_suppress_warning', $form_state['values']['icon_api_apache_suppress_warning'])
        ->save();

      // Remove message just set by building the form again.
      unset($_SESSION['messages']['warning']);
    }
    $bundles = icon_bundles();
    $saved_bundles = $form_state
      ->getValue('bundles');
    foreach ($bundles as $name => $bundle) {
      if (!isset($saved_bundles[$name]['status'])) {
        continue;
      }
      $status = $saved_bundles[$name]['status'];
      if ($status !== $bundle['status']) {
        if ($status) {
          icon_bundle_enable($bundle);
        }
        else {
          icon_bundle_disable($bundle);
        }
      }
    }
    parent::submitForm($form, $form_state);
  }

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

}

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