You are here

class VariantPluginAddBlockForm in Page Manager 8.4

Same name and namespace in other branches
  1. 8 page_manager_ui/src/Form/VariantPluginAddBlockForm.php \Drupal\page_manager_ui\Form\VariantPluginAddBlockForm

Provides a form for adding a block plugin to a variant.

Hierarchy

Expanded class hierarchy of VariantPluginAddBlockForm

1 string reference to 'VariantPluginAddBlockForm'
page_manager_ui.routing.yml in page_manager_ui/page_manager_ui.routing.yml
page_manager_ui/page_manager_ui.routing.yml

File

page_manager_ui/src/Form/VariantPluginAddBlockForm.php, line 14

Namespace

Drupal\page_manager_ui\Form
View source
class VariantPluginAddBlockForm extends VariantPluginConfigureBlockFormBase {

  /**
   * The block manager.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $blockManager;

  /**
   * Constructs a new VariantPluginFormBase.
   *
   * @param \Drupal\Core\TempStore\SharedTempStoreFactory $tempstore
   *   The shared temp store.
   * @param \Drupal\Component\Plugin\PluginManagerInterface $block_manager
   *   The block manager.
   */
  public function __construct(SharedTempStoreFactory $tempstore, PluginManagerInterface $block_manager) {
    parent::__construct($tempstore);
    $this->blockManager = $block_manager;
  }

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

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

  /**
   * {@inheritdoc}
   */
  protected function prepareBlock($plugin_id) {
    $block = $this->blockManager
      ->createInstance($plugin_id);
    $block_id = $this
      ->getVariantPlugin()
      ->addBlock($block
      ->getConfiguration());
    return $this
      ->getVariantPlugin()
      ->getBlock($block_id);
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $block_display = NULL, $block_id = NULL, Request $request = NULL) {
    $form = parent::buildForm($form, $form_state, $block_display, $block_id);
    $form['region']['#default_value'] = $request->query
      ->get('region');
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  protected function submitText() {
    return $this
      ->t('Add block');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginAssignmentTrait::t abstract protected function Ensures the t() method is available.
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
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.
VariantPluginAddBlockForm::$blockManager protected property The block manager.
VariantPluginAddBlockForm::buildForm public function Form constructor. Overrides VariantPluginConfigureBlockFormBase::buildForm
VariantPluginAddBlockForm::create public static function Instantiates a new instance of this class. Overrides VariantPluginConfigureBlockFormBase::create
VariantPluginAddBlockForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
VariantPluginAddBlockForm::prepareBlock protected function Prepares the block plugin based on the block ID. Overrides VariantPluginConfigureBlockFormBase::prepareBlock
VariantPluginAddBlockForm::submitText protected function Returns the text to use for the submit button. Overrides VariantPluginConfigureBlockFormBase::submitText
VariantPluginAddBlockForm::__construct public function Constructs a new VariantPluginFormBase. Overrides VariantPluginConfigureBlockFormBase::__construct
VariantPluginConfigureBlockFormBase::$block protected property The plugin being configured.
VariantPluginConfigureBlockFormBase::$tempstore protected property Tempstore factory.
VariantPluginConfigureBlockFormBase::$variantPlugin protected property The variant plugin.
VariantPluginConfigureBlockFormBase::getTempstore protected function Get the tempstore.
VariantPluginConfigureBlockFormBase::getTempstoreId protected function Get the tempstore id.
VariantPluginConfigureBlockFormBase::getVariantPlugin protected function Gets the variant plugin for this page variant entity.
VariantPluginConfigureBlockFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm
VariantPluginConfigureBlockFormBase::validateForm public function Form validation handler. Overrides FormBase::validateForm