class DashboardBlockConfigForm 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\DashboardBlockConfigForm

Expanded class hierarchy of DashboardBlockConfigForm

1 string reference to 'DashboardBlockConfigForm'

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

File

src/Form/DashboardBlockConfigForm.php, line 14

Namespace

Drupal\content_planner\Form

View source

class DashboardBlockConfigForm 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 service.
   */
  public function __construct(ConfigFactoryInterface $config_factory) {
    parent::__construct($config_factory);
    $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_block_config_form';
  }

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

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

    // Get plugin definition.
    $plugin_definition = $this->dashboardBlockPluginManager
      ->getDefinition($block_id);
    if (!$plugin_definition) {
      $this
        ->messenger()
        ->addError($this
        ->t('Plugin with @block_id does not exist', [
        '@block_id' => $block_id,
      ]));
      return [];
    }
    $form['block_id'] = [
      '#type' => 'value',
      '#value' => $block_id,
    ];

    // Get block configuration.
    $block_configuration = $this->dashboardSettingsService
      ->getBlockConfiguration($block_id);

    // Build Basic Fields.
    $this
      ->buildBasicFields($form, $form_state, $request, $block_configuration);

    // Create instance.
    $instance = $this
      ->createInstanceFromBlockId($block_id);

    // Build plugin form elements.
    if ($config_specific_fields = $instance
      ->getConfigSpecificFormFields($form_state, $request, $block_configuration)) {
      $form['plugin_specific_config'] = [
        '#type' => 'fieldset',
        '#title' => t('Extra Settings'),
        '#collapsible' => FALSE,
        '#collapsed' => FALSE,
        '#tree' => TRUE,
      ];
      foreach ($config_specific_fields as $field_name => $field_settings) {
        $form['plugin_specific_config'][$field_name] = $field_settings;
      }
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * Build Basic fields which are the same for every Dashboard Block Plugin.
   */
  protected function buildBasicFields(array &$form, FormStateInterface &$form_state, Request &$request, $block_configuration) {
    $form['title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Title'),
      '#maxlength' => 255,
      '#default_value' => isset($block_configuration['title']) ? $block_configuration['title'] : '',
      '#description' => $this
        ->t("If this field is blank, the Plugin's default name will be used."),
    ];
    $form['weight'] = [
      '#type' => 'weight',
      '#title' => $this
        ->t('Weight'),
      '#default_value' => isset($block_configuration['weight']) ? $block_configuration['weight'] : 0,
      '#delta' => 10,
    ];
  }

  /**
   * Creates dashboard board plugin instances.
   *
   * @param string $block_id
   *   The plugin id to create an instance for.
   *
   * @return \Drupal\content_planner\DashboardBlockInterface
   *   A dashboard block plugin instance.
   */
  protected function createInstanceFromBlockId($block_id) {
    $plugin_definition = $this->dashboardBlockPluginManager
      ->getDefinition($block_id);
    return $this->dashboardBlockPluginManager
      ->createInstance($plugin_definition['id']);
  }

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

    // Validate form by parent.
    parent::validateForm($form, $form_state);

    // Get block id from from state.
    $block_id = $form_state
      ->getValue('block_id');

    // Create instance.
    $instance = $this
      ->createInstanceFromBlockId($block_id);

    // Validate form by plugin.
    $instance
      ->validateForm($form, $form_state);
  }

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

    // Get block id from from state.
    $block_id = $form_state
      ->getValue('block_id');

    // Get specific block configuration.
    $block_configuration = $this->dashboardSettingsService
      ->getBlockConfiguration($block_id);

    // Set fields.
    $block_configuration['title'] = $form_state
      ->getValue('title');
    $block_configuration['weight'] = $form_state
      ->getValue('weight');
    $block_configuration['configured'] = TRUE;
    $block_configuration['plugin_specific_config'] = $form_state
      ->getValue('plugin_specific_config');

    // Save configurations back into config.
    $this->dashboardSettingsService
      ->saveBlockConfiguration($block_id, $block_configuration);
  }

}

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.
DashboardBlockConfigForm::$dashboardBlockPluginManager	protected	property	The Dashboard block plugin manager.
DashboardBlockConfigForm::$dashboardSettingsService	protected	property	The dashboard settings service.
DashboardBlockConfigForm::buildBasicFields	protected	function	Build Basic fields which are the same for every Dashboard Block Plugin.
DashboardBlockConfigForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
DashboardBlockConfigForm::createInstanceFromBlockId	protected	function	Creates dashboard board plugin instances.
DashboardBlockConfigForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
DashboardBlockConfigForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
DashboardBlockConfigForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
DashboardBlockConfigForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
DashboardBlockConfigForm::__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.
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 DashboardBlockConfigForm in Content Planner 8

Hierarchy

File

Namespace

Members

API Navigation