You are here

Home » API reference » Opigno dashboard 8 » SettingsForm.php

class SettingsForm in Opigno dashboard 8

Same name and namespace in other branches
  1. 3.x src/Form/SettingsForm.php \Drupal\opigno_dashboard\Form\SettingsForm

Class SettingsForm.

Hierarchy

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'
opigno_dashboard.routing.yml in ./opigno_dashboard.routing.yml
opigno_dashboard.routing.yml

File

src/Form/SettingsForm.php, line 15

Namespace

Drupal\opigno_dashboard\Form
View source 
class SettingsForm extends ConfigFormBase {

  /**
   * The block service.
   *
   * @var \Drupal\opigno_dashboard\BlockServiceInterface
   */
  protected $blockService;

  /**
   * The theme handler.
   *
   * @var \Drupal\Core\Extension\ThemeHandlerInterface
   */
  protected $themeHandler;

  /**
   * Constructs a \Drupal\opigno_dashboard\Form\SettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\opigno_dashboard\BlockServiceInterface $block_service
   *   The block service object.
   * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
   *   The theme handler.
   */
  public function __construct(ConfigFactoryInterface $config_factory, BlockServiceInterface $block_service, ThemeHandlerInterface $theme_handler) {
    parent::__construct($config_factory);
    $this->blockService = $block_service;
    $this->themeHandler = $theme_handler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('opigno_dashboard.block'), $container
      ->get('theme_handler'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['#title'] = $this
      ->t('Dashboard settings');
    $config = $this
      ->config('opigno_dashboard.settings');
    $config_blocks = $config
      ->get('blocks');
    $config_theme = $config
      ->get('theme');
    $blocks = $this->blockService
      ->getAllBlocks();
    $themes = [];
    foreach ($this->themeHandler
      ->listInfo() as $theme) {
      $themes[$theme
        ->getName()] = $theme->info['name'];
    }
    $form['theme'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Theme selection'),
      '#options' => $themes,
      '#default_value' => isset($config_theme) ? $config_theme : $this
        ->config('system.theme')
        ->get('default'),
      '#description' => $this
        ->t("The dashboard blocks will be created under this theme. A region named 'content' is required."),
    ];
    $form['blocks_label'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Dashboard Blocks'),
    ];
    $form['blocks'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Name'),
        $this
          ->t('Available'),
        $this
          ->t('Mandatory'),
      ],
    ];
    foreach ($blocks as $id => $block) {
      $form['blocks'][$id]['name'] = [
        '#markup' => $block['admin_label'],
      ];
      $form['blocks'][$id]['available'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Available'),
        '#title_display' => 'invisible',
        '#default_value' => isset($config_blocks[$id]['available']) ? $config_blocks[$id]['available'] : NULL,
      ];
      $form['blocks'][$id]['mandatory'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Mandatory'),
        '#title_display' => 'invisible',
        '#default_value' => isset($config_blocks[$id]['mandatory']) ? $config_blocks[$id]['mandatory'] : NULL,
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Save settings.
    $this
      ->config('opigno_dashboard.settings')
      ->set('blocks', $form_state
      ->getValue('blocks'))
      ->set('theme', $form_state
      ->getValue('theme'))
      ->save();
    $this->blockService
      ->createBlocksInstances($form_state
      ->getValue('blocks'));
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
SettingsForm::$blockService protected property The block service.
SettingsForm::$themeHandler protected property The theme handler.
SettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SettingsForm::__construct public function Constructs a \Drupal\opigno_dashboard\Form\SettingsForm object. Overrides ConfigFormBase::__construct
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.