You are here

Home » API reference » Draggable dashboard 8.2 » DashboardConfigureBlockForm.php

class DashboardConfigureBlockForm in Draggable dashboard 8.2

Class DashboardConfigureBlockForm

@package Drupal\draggable_dashboard\Form

Hierarchy

Expanded class hierarchy of DashboardConfigureBlockForm

1 string reference to 'DashboardConfigureBlockForm'
draggable_dashboard.routing.yml in ./draggable_dashboard.routing.yml
draggable_dashboard.routing.yml

File

src/Form/DashboardConfigureBlockForm.php, line 13

Namespace

Drupal\draggable_dashboard\Form
View source 
class DashboardConfigureBlockForm extends DashboardBlockFormBase {

  /**
   * Block id to configure.
   *
   * @var string
   */
  protected $block_id;

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

  /**
   * Initialize the form state and the entity before the first form build.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state object.
   * @param \Drupal\draggable_dashboard\Entity\DashboardEntityInterface $dashboard_entity
   *   Dashboard object.
   * @param string $block_id
   *   Id of the block to configure.
   */
  protected function init(FormStateInterface $form_state, DashboardEntityInterface $dashboard_entity, $block_id = '') {
    parent::init($form_state, $dashboard_entity);
    $blocks = $dashboard_entity
      ->get('blocks');
    if (!empty($blocks[$block_id])) {
      $this->block = $blocks[$block_id];
    }
    else {
      $this->block = [
        'settings' => [
          'id' => 'broken',
        ],
      ];
    }
    $this->block_id = $block_id;
  }

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

    // During the initial form build, add this form object to the form state and
    // allow for initial preparation before form building and processing.
    if (!$form_state
      ->has('form_initialized')) {
      $this
        ->init($form_state, $dashboard_entity, $block_id);
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $blocks = $this->dashboard
      ->get('blocks') ? $this->dashboard
      ->get('blocks') : [];
    $blocks[$this->block_id]['settings'] = $form_state
      ->getValue('settings');

    // Save relation.
    $this->dashboard
      ->set('blocks', $blocks)
      ->save();

    // Redirect to manage blocks screen.
    $form_state
      ->setRedirect('entity.dashboard_entity.edit_form', [
      'dashboard_entity' => $this->dashboard
        ->id(),
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DashboardBlockFormBase::$block protected property Block settings.
DashboardBlockFormBase::$blockManager protected property The block manager.
DashboardBlockFormBase::$contextRepository protected property The context repository.
DashboardBlockFormBase::$dashboard protected property Current Dashboard.
DashboardBlockFormBase::$pluginFormFactory protected property The plugin form manager.
DashboardBlockFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create
DashboardBlockFormBase::getPluginForm protected function Retrieves the plugin form for a given block and operation.
DashboardBlockFormBase::validateForm public function Form validation handler. Overrides FormBase::validateForm
DashboardConfigureBlockForm::$block_id protected property Block id to configure.
DashboardConfigureBlockForm::buildForm public function Form constructor. Overrides DashboardBlockFormBase::buildForm
DashboardConfigureBlockForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
DashboardConfigureBlockForm::init protected function Initialize the form state and the entity before the first form build. Overrides DashboardBlockFormBase::init
DashboardConfigureBlockForm::submitForm public function Form submission handler. Overrides DashboardBlockFormBase::submitForm
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.
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.