You are here

Home » API reference » Simple Style Guide 8 » StyleguideSettings.php

class StyleguideSettings in Simple Style Guide 8

Class StyleguideSettings.

@package Drupal\simple_styleguide\Form

Hierarchy

Expanded class hierarchy of StyleguideSettings

1 string reference to 'StyleguideSettings'
simple_styleguide.routing.yml in ./simple_styleguide.routing.yml
simple_styleguide.routing.yml

File

src/Form/StyleguideSettings.php, line 14

Namespace

Drupal\simple_styleguide\Form
View source 
class StyleguideSettings extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('simple_styleguide.styleguidesettings');
    $form['intro'] = [
      '#markup' => 'Choose any of the default html patterns you would like to see on your styleguide. You can also create custom patterns as needed.',
    ];
    $form['default_patterns'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Default Patterns'),
      '#options' => [
        'headings' => 'headings',
        'text' => 'text',
        'lists' => 'lists',
        'blockquote' => 'blockquote',
        'rule' => 'horizontal rule',
        'table' => 'table',
        'alerts' => 'alerts',
        'breadcrumbs' => 'breadcrumbs',
        'forms' => 'forms',
        'buttons' => 'buttons',
        'pagination' => 'pagination',
      ],
      '#default_value' => !empty($config
        ->get('default_patterns')) && count($config
        ->get('default_patterns')) > 0 ? $config
        ->get('default_patterns') : [],
    ];
    $button_link = Url::fromRoute('entity.styleguide_pattern.collection')
      ->toString();
    $form['custom'] = [
      '#markup' => '<p><a href="' . $button_link . '" class="button">Create Custom Styleguide Patterns</a></p>',
    ];
    $form['color_palette'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Color Palette'),
    ];
    $form['color_palette']['default_colors'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Hex Color Code|Class Name|Usage Description'),
      '#default_value' => $config
        ->get('default_colors') ? implode("\r\n", $config
        ->get('default_colors')) : '',
      '#description' => $this
        ->t('For example: #FF0000|red|Usage text...'),
      '#prefix' => $this
        ->t('<p>Create a list of all the colors you would like represented in your styleguide. Each color should be on a separate line. By default, hex values will be used in an inline style for the color palette section of the styleguide.</p>'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $config = $this
      ->config('simple_styleguide.styleguidesettings');
    $config
      ->set('default_patterns', $form_state
      ->getValue('default_patterns'));
    $config
      ->set('default_colors', explode("\r\n", $form_state
      ->getValue('default_colors')));
    $config
      ->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.
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.
StyleguideSettings::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
StyleguideSettings::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
StyleguideSettings::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
StyleguideSettings::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
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.