You are here

Home » API reference » Skinr 8.2 » SkinsEditForm.php

class SkinsEditForm in Skinr 8.2

Hierarchy

Expanded class hierarchy of SkinsEditForm

1 string reference to 'SkinsEditForm'
skinr_ui.routing.yml in skinr_ui/skinr_ui.routing.yml
skinr_ui/skinr_ui.routing.yml

File

skinr_ui/src/Form/SkinsEditForm.php, line 15
Contains Drupal\skinr_ui\Form\SkinsEditForm.

Namespace

Drupal\skinr_ui\Form
View source 
class SkinsEditForm extends FormBase {

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

  /**
   * Returns a page title.
   *
   * @param string $element_type
   *   The current element's type.
   * @param string $element
   *   The current element.
   * @param string $theme
   *   The theme this
   *
   * @return string
   */
  public function getTitle($element_type = NULL, $element = NULL, $theme = NULL) {
    $skin = Skin::create(array(
      'element_type' => $element_type,
      'element' => $element,
      'theme' => $theme,
    ));
    return t('Skin settings for !element !element_type', array(
      '!element_type' => strtolower($skin
        ->elementTypeLabel()),
      '!element' => $skin
        ->elementLabel(),
    ));
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $element_type = NULL, $element = NULL, $theme = NULL) {
    if ($theme === NULL) {
      $theme = \Drupal::theme()
        ->getActiveTheme()
        ->getName();
    }
    $theme_handler = \Drupal::service('theme_handler');

    /** @var Extension[]|\stdClass[] $themes */
    $themes = $theme_handler
      ->listInfo();
    ksort($themes);
    $form['current_theme'] = array(
      '#type' => 'value',
      '#value' => $theme,
    );
    $defaults = array();
    if ($form_state
      ->hasValue('skinr_settings')) {
      $defaults = $form_state
        ->getValue('skinr_settings');
    }
    else {
      foreach ($themes as $section_theme) {
        if (!$section_theme->status) {
          continue;
        }
        $section_theme_name = $section_theme
          ->getName();
        $properties = array(
          'element_type' => $element_type,
          'element' => $element,
          'theme' => $section_theme_name,
        );

        /** @var Skin[] $skins */
        $skins = \Drupal::entityManager()
          ->getStorage('skin')
          ->loadByProperties($properties);
        foreach ($skins as $skin) {
          $defaults[$section_theme_name][$skin->skin] = $skin
            ->getOptions();
        }
      }

      // Set default values.
      $form_state
        ->setValue('skinr_settings', $defaults);
    }

    // Display info.
    $skin = Skin::create(array(
      'element_type' => $element_type,
      'element' => $element,
      'theme' => $theme,
    ));
    $form['info']['element_type_info'] = array(
      '#type' => 'item',
      '#title' => t('Type'),
      '#markup' => $skin
        ->elementTypeLabel(),
    );
    $form['info']['element_info'] = array(
      '#type' => 'item',
      '#title' => t('Element'),
      '#markup' => $skin
        ->elementLabel(),
    );

    // Set form class.
    $form['#attributes'] = array(
      'class' => array(
        'skinr-form',
      ),
    );
    $form['actions'] = array(
      '#type' => 'actions',
    );
    $form['actions']['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Save'),
      '#weight' => 50,
    );
    $form['skinr']['element_type'] = array(
      '#type' => 'hidden',
      '#value' => $element_type,
    );
    $form['skinr']['element'] = array(
      '#type' => 'hidden',
      '#value' => $element,
    );
    $groups = skinr_get_group_info();
    $skin_infos = skinr_get_skin_info();

    // Apply overridden status to skins.
    foreach ($skin_infos as $skin_name => $skin_info) {
      $skin_infos[$skin_name]['status'] = skinr_skin_info_status_get($skin_infos[$skin_name]);
    }

    // Invoke hook_skinr_theme_hooks() and hook_skinr_theme_hooks_alter().
    $theme_hooks = skinr_theme_hooks($element_type, $element);
    $form['skinr_settings'] = array(
      '#tree' => TRUE,
      '#type' => 'container',
    );
    foreach ($themes as $section_theme) {
      if (!$section_theme->status) {
        continue;
      }
      $section_theme_name = $section_theme
        ->getName();

      // If this hook is a region, and the region does not exist for this
      // theme, don't bother outputting any of the settings.
      if (!empty($section_theme_hooks) && strpos($theme_hooks[0], 'region') === 0) {

        // Strip the region__ part off the region name.
        $region = substr($theme_hooks[0], 8);
        $regions = system_region_list($section_theme_name, REGIONS_VISIBLE);
        if (!isset($regions[$region])) {
          continue;
        }
      }

      // Build theme sub-form.
      $form['skinr_settings'][$section_theme_name] = array(
        '#type' => 'details',
        '#title' => $section_theme->info['name'] . ($section_theme_name == $section_theme ? ' (' . t('enabled + default') . ')' : ''),
        '#open' => $section_theme_name == $theme ? TRUE : FALSE,
      );
      if ($section_theme_name == $theme) {

        // Current theme goes at the top.
        $form['skinr_settings'][$section_theme_name]['#attributes'] = array(
          'class' => array(
            'skinr-ui-current-theme',
          ),
        );
        $form['skinr_settings'][$section_theme_name]['#weight'] = -10;
      }

      // Use vertical tabs.
      $form['skinr_settings'][$section_theme_name]['groups'] = array(
        '#type' => 'vertical_tabs',
      );

      // Create individual widgets for each skin.
      foreach ($skin_infos as $skin_name => $skin_info) {

        // Check if this skin is disabled.
        if (empty($skin_info['status'][$section_theme_name])) {
          continue;
        }

        // Check if this skin applies to this hook.
        if (!is_array($skin_info['theme hooks']) || !in_array('*', $skin_info['theme hooks']) && !$this
          ->isFeatured($theme_hooks, $skin_info['theme hooks'])) {
          continue;
        }

        // Create widget.
        $field = array();
        if (!empty($skin_info['form callback'])) {

          // Process custom form callbacks.
          // Load include file.
          if (!empty($skin_info['source']['include file'])) {
            skinr_load_include($skin_info['source']['include file']);
          }

          // Execute form callback.
          if (function_exists($skin_info['form callback'])) {
            $context = array(
              'theme' => $section_theme_name,
              'skin_name' => $skin_name,
              'skin_info' => $skin_info,
              'value' => isset($defaults[$section_theme_name][$skin_name]) ? $defaults[$section_theme_name][$skin_name] : array(),
            );
            $field = $skin_info['form callback']($form, $form_state, $context);
          }
        }
        else {
          switch ($skin_info['type']) {
            case 'checkboxes':
              $field = array(
                '#type' => 'checkboxes',
                '#multiple' => TRUE,
                '#title' => $skin_info['title'],
                '#options' => $this
                  ->optionsToFormOptions($skin_info['options']),
                '#default_value' => isset($defaults[$section_theme_name][$skin_name]) ? $defaults[$section_theme_name][$skin_name] : array(),
                '#description' => $skin_info['description'],
                '#weight' => isset($skin_info['weight']) ? $skin_info['weight'] : NULL,
              );
              break;
            case 'radios':
              $field = array(
                '#type' => 'radios',
                '#title' => $skin_info['title'],
                '#options' => array_merge(array(
                  '' => '<none>',
                ), $this
                  ->optionsToFormOptions($skin_info['options'])),
                '#default_value' => isset($defaults[$section_theme_name][$skin_name]) ? $defaults[$section_theme_name][$skin_name] : '',
                '#description' => $skin_info['description'],
                '#weight' => isset($skin_info['weight']) ? $skin_info['weight'] : NULL,
              );
              break;
            case 'select':
              $field = array(
                '#type' => 'select',
                '#title' => $skin_info['title'],
                '#options' => array_merge(array(
                  '' => '<none>',
                ), $this
                  ->optionsToFormOptions($skin_info['options'])),
                '#default_value' => isset($defaults[$section_theme_name][$skin_name]) ? $defaults[$section_theme_name][$skin_name] : '',
                '#description' => $skin_info['description'],
                '#weight' => isset($skin_info['weight']) ? $skin_info['weight'] : NULL,
              );
              break;
            default:

              // Raise an error.
              drupal_set_message(t("Widget %name's type is invalid.", array(
                '%name' => $skin_name,
              )), 'error', FALSE);
              break;
          }
        }
        if (empty($skin_info['group']) || empty($groups[$skin_info['group']])) {
          $form['skinr_settings'][$section_theme_name][$skin_name] = $field;
        }
        else {
          if (!empty($field) && !isset($form['skinr_settings'][$section_theme_name]['groups'][$skin_info['group']])) {
            $group = $groups[$skin_info['group']];
            $form['skinr_settings'][$section_theme_name]['groups'][$skin_info['group']] = array(
              '#type' => 'details',
              '#title' => $group['title'],
              '#description' => $group['description'],
              '#group' => 'skinr_settings][' . $section_theme_name . '][groups',
              '#weight' => isset($group['weight']) ? $group['weight'] : NULL,
            );
          }
          $form['skinr_settings'][$section_theme_name]['groups'][$skin_info['group']][$skin_name] = $field;
        }
      }

      // Check for access.
      if (skinr_ui_access('edit advanced skin settings')) {
        $skin_name = '_additional';
        $form['skinr_settings'][$section_theme_name]['groups']['_additional'] = array(
          '#type' => 'details',
          '#title' => t('Advanced'),
          '#group' => 'skinr_settings][' . $section_theme_name . '][groups',
          '#weight' => 50,
        );
        $form['skinr_settings'][$section_theme_name]['groups']['_additional']['_additional'] = array(
          '#type' => 'textfield',
          '#title' => t('CSS classes'),
          '#size' => 40,
          '#description' => t('To add CSS classes manually, enter classes separated by a single space i.e. <code>first-class second-class</code>'),
          '#default_value' => isset($defaults[$section_theme_name][$skin_name]) ? $defaults[$section_theme_name][$skin_name] : '',
        );
      }
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $element_type = $form_state
      ->getValue('element_type');
    $element = $form_state
      ->getValue('element');
    $error = FALSE;
    if ($form_state
      ->hasValue('skinr_settings')) {
      foreach ($form_state
        ->getValue('skinr_settings') as $section_theme_name => $section_theme) {
        if (isset($section_theme['groups']['_additional']['_additional'])) {

          // Validate additional classes field.
          if (preg_match('/[^a-zA-Z0-9\\-\\_\\s]/', $section_theme['groups']['_additional']['_additional'])) {
            $form_state
              ->setErrorByName('skinr_settings][' . $section_theme_name . '][groups][_additional][_additional', t('Additional classes for Skinr may only contain alphanumeric characters, spaces, - and _.'));
            $error = TRUE;
          }
        }
      }
    }
    if (!$error) {
      $groups = skinr_get_group_info();

      // Add hard-coded additional classes group.
      $groups['_additional'] = array(
        'title' => t('Additional'),
        'description' => t('Additional custom classes.'),
        'weight' => 0,
      );
      if ($form_state
        ->hasValue('skinr_settings')) {
        $skinr_settings = $form_state
          ->getValue('skinr_settings');
        foreach ($skinr_settings as $section_theme_name => $section_theme) {

          // Unset active tab variables.
          foreach ($section_theme['groups'] as $skin_name => $options) {
            if (strpos($skin_name, '__groups__active_tab') !== FALSE) {
              unset($skinr_settings[$section_theme_name]['groups'][$skin_name]);
              continue;
            }
          }

          // Undo any grouping to ease processing on submit.
          foreach ($groups as $group_name => $group) {
            if (!empty($section_theme['groups'][$group_name]) && is_array($section_theme['groups'][$group_name])) {
              $group_values = $section_theme['groups'][$group_name];
              unset($skinr_settings[$section_theme_name]['groups'][$group_name]);
              $skinr_settings[$section_theme_name] = array_merge($skinr_settings[$section_theme_name], $group_values);
            }
          }
          unset($skinr_settings[$section_theme_name]['groups']);
        }
        $form_state
          ->setValue('skinr_settings', $skinr_settings);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $element_type = $form_state
      ->getValue('element_type');
    $element = $form_state
      ->getValue('element');
    if ($form_state
      ->hasValue('skinr_settings')) {
      foreach ($form_state
        ->getValue('skinr_settings') as $section_theme_name => $section_theme) {

        // Process widgets.
        if (!empty($section_theme) && is_array($section_theme)) {
          foreach ($section_theme as $skin_name => $options) {
            if ($skin_name == '_additional' && !\Drupal::currentUser()
              ->hasPermission('edit advanced skin settings')) {

              // This user doesn't have access to alter these options.
              continue;
            }

            // Ensure options is an array.
            if (!is_array($options)) {
              $options = $skin_name == '_additional' ? explode(' ', $options) : array(
                $options,
              );
            }

            // Sanitize options.
            $options = _skinr_array_strip_empty($options);

            // Find existing skin.
            unset($skin);
            $properties = array(
              'theme' => $section_theme_name,
              'element_type' => $element_type,
              'element' => $element,
              'skin' => $skin_name,
            );

            /** @var Skin[] $skins */
            $skins = \Drupal::entityManager()
              ->getStorage('skin')
              ->loadByProperties($properties);
            if ($skins) {
              $skin = reset($skins);
            }
            if (empty($options)) {
              if (!empty($skin)) {

                // Delete this skin configuration.
                $skin
                  ->delete();
              }
              continue;
            }
            if (empty($skin)) {

              // It doesn't exist, so create a new skin.
              $skin = Skin::create(array(
                'element_type' => $element_type,
                'element' => $element,
                'theme' => $section_theme_name,
                'skin' => $skin_name,
              ));
            }
            $skin
              ->setOptions($options);
            $skin
              ->enable();

            // Save skin.
            $skin
              ->save();
          }
        }
      }
    }
  }

  /**
   * Helper function to convert an array of options, as specified in the .info
   * file, into an array usable by Form API.
   *
   * @param $options
   *   An array containing at least the 'class' and 'label' keys.
   *
   * @return string[]
   *   A Form API compatible array of options.
   *
   * @todo Rename function to be more descriptive.
   */
  protected function optionsToFormOptions($options) {
    $form_options = array();
    foreach ($options as $option_name => $option) {
      $form_options[$option_name] = $option['title'];
    }
    return $form_options;
  }

  /**
   * Helper function to determine whether one of a set of hooks exists in a list
   * of required theme hooks.
   *
   * @param $theme_hooks
   *   An array of theme hooks available to this element.
   * @param $allowed_hooks
   *   An array of allowed theme hooks.
   *
   * @return boolean
   *   TRUE if an overlap is found, FALSE otherwise.
   *
   * @todo Rename function to be more descriptive.
   */
  protected function isFeatured($theme_hooks, $allowed_hooks) {
    foreach ($theme_hooks as $theme_hook) {
      if (in_array($theme_hook, $allowed_hooks)) {
        return TRUE;
      }
    }
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
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.
SkinsEditForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
SkinsEditForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SkinsEditForm::getTitle public function Returns a page title.
SkinsEditForm::isFeatured protected function Helper function to determine whether one of a set of hooks exists in a list of required theme hooks.
SkinsEditForm::optionsToFormOptions protected function Helper function to convert an array of options, as specified in the .info file, into an array usable by Form API.
SkinsEditForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
SkinsEditForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.