class DashboardSettingsForm in Content Planner 8

Defines a form that configures forms module settings.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\content_planner\Form\DashboardSettingsForm

Expanded class hierarchy of DashboardSettingsForm

1 string reference to 'DashboardSettingsForm'

content_planner.routing.yml in ./content_planner.routing.yml: content_planner.routing.yml

File

src/Form/DashboardSettingsForm.php, line 17

Namespace

Drupal\content_planner\Form

View source

class DashboardSettingsForm extends ConfigFormBase {

  /**
   * The dashboard settings service.
   *
   * @var \Drupal\content_planner\DashboardSettingsService
   */
  protected $dashboardSettingsService;

  /**
   * The dashboard block plugin manager.
   *
   * @var \Drupal\content_planner\DashboardBlockPluginManager
   */
  protected $dashboardBlockPluginManager;

  /**
   * SettingsForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   */
  public function __construct(ConfigFactoryInterface $config_factory) {
    parent::__construct($config_factory);

    // Get config.
    $this->dashboardSettingsService = \Drupal::service('content_planner.dashboard_settings_service');
    $this->dashboardBlockPluginManager = \Drupal::service('content_planner.dashboard_block_plugin_manager');
  }

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      DashboardSettingsService::CONFIG_NAME,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, Request $request = NULL) {

    // Get block configurations from settings.
    $block_configurations = $this->dashboardSettingsService
      ->getBlockConfigurations();

    // Get registered Plugins.
    $plugins = $this->dashboardBlockPluginManager
      ->getDefinitions();
    uksort($plugins, function ($a, $b) {
      return strnatcmp($a, $b);
    });
    $block_options = [];

    // Loop over every plugin and generate renderable array.
    foreach ($plugins as $plugin_id => $plugin) {
      $block_options[$plugin_id] = $plugin['name'];
      if (array_key_exists($plugin_id, $block_configurations)) {
        $config_link = Link::createFromRoute($this
          ->t('Configure'), 'content_planner.dashboard_block_config_form', [
          'block_id' => $plugin_id,
        ], [
          'query' => [
            'destination' => Url::fromRoute('content_planner.dashboard_settings')
              ->toString(),
          ],
        ]);
        $block_options[$plugin_id] .= ' (' . $config_link
          ->toString() . ')';
      }
    }

    // Default value.
    if ($block_configurations) {
      $default_value = array_keys($block_configurations);
    }
    else {
      $default_value = [];
    }
    $form['available_dashboard_blocks'] = [
      '#type' => 'fieldset',
      '#title' => t('Dashboard Widgets'),
      '#collapsible' => FALSE,
      '#collapsed' => FALSE,
    ];
    $form['available_dashboard_blocks']['enabled_blocks'] = [
      '#type' => 'checkboxes',
      '#title' => t('Available Dashboard Widgets'),
      '#description' => t('Select which Widgets should be displayed in the Dashboard.'),
      // '#required' => TRUE,.
      '#options' => $block_options,
      '#default_value' => $default_value,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $block_configurations = $this->dashboardSettingsService
      ->getBlockConfigurations();

    // Get values.
    $values = $form_state
      ->getValues();
    foreach ($values['enabled_blocks'] as $key => $selected) {
      if ($selected) {

        // If the block is not in the config already.
        if (!array_key_exists($key, $block_configurations)) {
          $config = DashboardBlockBase::getBasicConfigStructure();
          $config['plugin_id'] = $key;
          $block_configurations[$key] = $config;
        }
      }
      else {

        // Delete block if deselecte.
        if (array_key_exists($key, $block_configurations)) {
          unset($block_configurations[$key]);
        }
      }
    }

    // Save.
    $this->dashboardSettingsService
      ->saveBlockConfigurations($block_configurations);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	13
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DashboardSettingsForm::$dashboardBlockPluginManager	protected	property	The dashboard block plugin manager.
DashboardSettingsForm::$dashboardSettingsService	protected	property	The dashboard settings service.
DashboardSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
DashboardSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
DashboardSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
DashboardSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
DashboardSettingsForm::__construct	public	function	SettingsForm constructor. Overrides ConfigFormBase::__construct
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.

You are here

class DashboardSettingsForm in Content Planner 8

Hierarchy

File

Namespace

Members

API Navigation