class DashboardAssignBlockForm in Draggable dashboard 8.2

Class DashboardAssignBlockForm

@package Drupal\draggable_dashboard\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\draggable_dashboard\Form\DashboardBlockFormBase
  - class \Drupal\draggable_dashboard\Form\DashboardAssignBlockForm

Expanded class hierarchy of DashboardAssignBlockForm

1 string reference to 'DashboardAssignBlockForm'

draggable_dashboard.routing.yml in ./draggable_dashboard.routing.yml: draggable_dashboard.routing.yml

File

src/Form/DashboardAssignBlockForm.php, line 13

Namespace

Drupal\draggable_dashboard\Form

View source

class DashboardAssignBlockForm extends DashboardBlockFormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'draggable_dashboard_assign_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 $plugin_id
   *   Plugin id of the block used.
   */
  protected function init(FormStateInterface $form_state, DashboardEntityInterface $dashboard_entity, $plugin_id = '') {
    parent::init($form_state, $dashboard_entity);
    $this->block = [
      'settings' => [
        'id' => $plugin_id,
      ],
    ];
  }

  /**
   * Builds assign block form.
   *
   * @param array $form
   *   Form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   * @param \Drupal\draggable_dashboard\Entity\DashboardEntityInterface|null $dashboard_entity
   *   Current dashboard.
   * @param string $plugin_id
   *   Block plugin id.
   * @param int $region
   *   Column to insert block to.
   *
   * @return array
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  public function buildForm(array $form, FormStateInterface $form_state, DashboardEntityInterface $dashboard_entity = NULL, $plugin_id = '', $region = 1) {

    // 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, $plugin_id);
    }
    $regions = [];
    for ($i = 1; $i <= $dashboard_entity
      ->get('columns'); $i++) {
      $regions[$i] = t('Column') . ' ' . $i;
    }
    $form['column'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Region'),
      '#description' => $this
        ->t('Select the region where this block should be displayed.'),
      '#default_value' => $region,
      '#required' => TRUE,
      '#options' => $regions,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * @param $machine_name
   * @param $form
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *
   * @return bool
   */
  public function blockIdExists($machine_name, $form, FormStateInterface $form_state) {

    // Get existing blocks from current dashboard.
    $dashboard_blocks = $this->dashboard
      ->get('blocks');

    // If empty return early.
    if (empty($dashboard_blocks)) {
      return FALSE;
    }
    $blocks = array_keys($dashboard_blocks);
    return in_array($machine_name, $blocks, TRUE);
  }

  /**
   * @param array $form
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $settings = $form_state
      ->getValue('settings');
    $id = $form_state
      ->getValue('id');
    $region = $form_state
      ->getValue('column');
    $blocks = $this->dashboard
      ->get('blocks') ? $this->dashboard
      ->get('blocks') : [];
    $blocks[$id] = [
      'column' => (int) $region,
      'settings' => $settings,
      'weight' => 0,
    ];

    // 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

Name	Modifiers	Type	Description	Overrides
DashboardAssignBlockForm::blockIdExists	public	function
DashboardAssignBlockForm::buildForm	public	function	Builds assign block form. Overrides DashboardBlockFormBase::buildForm
DashboardAssignBlockForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
DashboardAssignBlockForm::init	protected	function	Initialize the form state and the entity before the first form build. Overrides DashboardBlockFormBase::init
DashboardAssignBlockForm::submitForm	public	function	Overrides DashboardBlockFormBase::submitForm
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
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.

You are here

class DashboardAssignBlockForm in Draggable dashboard 8.2

Hierarchy

File

Namespace

Members

API Navigation