You are here

Home » API reference » Draggable dashboard 8 » DashboardFormBase.php

abstract class DashboardFormBase in Draggable dashboard 8

Provides a base class for draggable dashboard add/edit forms.

Hierarchy

Expanded class hierarchy of DashboardFormBase

File

src/Form/DashboardFormBase.php, line 15

Namespace

Drupal\draggable_dashboard\Form
View source 
abstract class DashboardFormBase extends FormBase {

  /**
   * Maximum dashboard columns count.
   */
  const MAX_COLUMNS_COUNT = 4;

  /**
   * An array containing the dashboard ID, etc.
   *
   * @var \Drupal\draggable_dashboard\Entity\DashboardEntity
   */
  protected $dashboard;

  /**
   * The theme manager.
   *
   * @var \Drupal\Core\Theme\ThemeManagerInterface
   */
  protected $themeManager;

  /**
   * The block manager.
   *
   * @var \Drupal\Core\Block\BlockManagerInterface
   */
  protected $blockManager;

  /**
   * DashboardFormBase constructor.
   *
   * @param \Drupal\Core\Theme\ThemeManagerInterface $theme_manager
   *   Theme manager.
   * @param \Drupal\Core\Block\BlockManagerInterface $block_manager
   *   Block manager.
   */
  public function __construct(ThemeManagerInterface $theme_manager, BlockManagerInterface $block_manager) {
    $this->themeManager = $theme_manager;
    $this->blockManager = $block_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('theme.manager'), $container
      ->get('plugin.manager.block'));
  }

  /**
   * Builds the path used by the form.
   *
   * @param int|null $did
   *   Either the unique path ID, or NULL if a new one is being created.
   */
  protected abstract function buildDashboard($did);

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $did = NULL) {
    $this->dashboard = $this
      ->buildDashboard($did);
    $form['title'] = [
      '#title' => $this
        ->t('Title'),
      '#type' => 'textfield',
      '#size' => 48,
      '#maxlength' => 255,
      '#default_value' => $this->dashboard
        ->get('title'),
      '#description' => '',
    ];
    $form['description'] = [
      '#title' => $this
        ->t('Description'),
      '#type' => 'textarea',
      '#default_value' => $this->dashboard
        ->get('description'),
      '#description' => '',
    ];
    $form['columns'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Dashboard columns'),
      '#options' => [
        1 => $this
          ->t('1 Column'),
        2 => $this
          ->t('2 Columns'),
        3 => $this
          ->t('3 Columns'),
        4 => $this
          ->t('4 Columns'),
      ],
      '#default_value' => $this->dashboard
        ->get('columns'),
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#button_type' => 'primary',
    ];
    return $form;
  }

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

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

    // Remove unnecessary values.
    $form_state
      ->cleanValues();
    $did = $form_state
      ->getValue('did', 0);
    $args = [
      'id' => empty($did) ? time() : $did,
      'title' => $form_state
        ->getValue('title', ''),
      'description' => $form_state
        ->getValue('description', ''),
      'columns' => $form_state
        ->getValue('columns', 2),
    ];
    foreach ($args as $key => $value) {
      $this->dashboard
        ->set($key, $value);
    }
    $this->dashboard
      ->save();

    // Delete block from column if number of columns has been changed.
    if (!empty($did) && $this->dashboard
      ->get('columns') > $args['columns']) {
      $all_blocks = json_decode($this->dashboard
        ->get('blocks'), TRUE);
      for ($i = $args['columns'] + 1; $i <= self::MAX_COLUMNS_COUNT; $i++) {
        foreach ($all_blocks as $key => $relation) {
          if ($relation['cln'] == $i) {
            $block = Block::load($relation['bid']);
            if ($block) {
              $block
                ->delete();
            }
            unset($all_blocks[$key]);
          }
        }
      }
      $this->dashboard
        ->set('blocks', json_encode($all_blocks))
        ->save();
    }

    // Invalidate block list cache.
    $this->blockManager
      ->clearCachedDefinitions();
    $this
      ->messenger()
      ->addMessage($this
      ->t('Dashboard has been saved.'));

    // Redirect just created dashboard to manage blocks page.
    if (empty($did)) {
      $form_state
        ->setRedirect('draggable_dashboard.manage_dashboard', [
        'did' => $args['id'],
      ]);
    }
    else {
      $form_state
        ->setRedirect('draggable_dashboard.overview');
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DashboardFormBase::$blockManager protected property The block manager.
DashboardFormBase::$dashboard protected property An array containing the dashboard ID, etc.
DashboardFormBase::$themeManager protected property The theme manager.
DashboardFormBase::buildDashboard abstract protected function Builds the path used by the form. 3
DashboardFormBase::buildForm public function Form constructor. Overrides FormInterface::buildForm 2
DashboardFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create
DashboardFormBase::MAX_COLUMNS_COUNT constant Maximum dashboard columns count.
DashboardFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm 1
DashboardFormBase::validateForm public function Form validation handler. Overrides FormBase::validateForm
DashboardFormBase::__construct public function DashboardFormBase constructor.
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::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.
FormInterface::getFormId public function Returns a unique string identifying the form. 236
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.