class BlocksSyncForm in Structure Sync 8

Same name and namespace in other branches

2.x src/Form/BlocksSyncForm.php \Drupal\structure_sync\Form\BlocksSyncForm

Import and export form for content in structure, like taxonomy terms.

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\structure_sync\Form\BlocksSyncForm

Expanded class hierarchy of BlocksSyncForm

1 string reference to 'BlocksSyncForm'

structure_sync.routing.yml in ./structure_sync.routing.yml: structure_sync.routing.yml

File

src/Form/BlocksSyncForm.php, line 16

Namespace

Drupal\structure_sync\Form

View source

class BlocksSyncForm extends ConfigFormBase {

  /**
   * The database.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;
  protected $entityTypeManager;

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

  /**
   * Class constructor.
   */
  public function __construct(ConfigFactoryInterface $config_factory, Connection $database, EntityTypeManagerInterface $entityManager) {
    parent::__construct($config_factory);
    $this->database = $database;
    $this->entityTypeManager = $entityManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('database'), $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'structure_sync.data',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $helper = new StructureSyncHelper();
    $form['title'] = [
      '#type' => 'page_title',
      '#title' => $this
        ->t('Custom blocks'),
    ];
    $form['export'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Export'),
      '#weight' => 1,
      '#open' => TRUE,
    ];
    $form['export']['blocks'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Export custom blocks'),
      '#name' => 'exportBlocks',
      '#button_type' => 'primary',
      '#submit' => [
        [
          $helper,
          'exportCustomBlocks',
        ],
      ],
    ];
    $blockList = [];
    $blocks = $this->entityTypeManager
      ->getStorage('block_content')
      ->loadMultiple();
    foreach ($blocks as $block) {
      $blockList[$block
        ->uuid()] = $block->info
        ->getValue()[0]['value'];
    }
    $form['export']['export_block_list'] = [
      '#type' => 'checkboxes',
      '#options' => $blockList,
      '#default_value' => array_keys($blockList),
      '#title' => $this
        ->t('Select the custom blocks you would like to export'),
    ];
    $form['import'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Import'),
      '#weight' => 2,
      '#open' => TRUE,
    ];
    $block_list = $this
      ->config('structure_sync.data')
      ->get('blocks');
    if (empty($block_list)) {
      $form['import']['import_no_data'] = [
        '#type' => 'markup',
        '#markup' => $this
          ->t("There's no data to import, please do an export first."),
      ];
      return $form;
    }
    $form['import']['import_blocks_safe'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Import custom blocks (safely)'),
      '#name' => 'importBlocksSafe',
      '#button_type' => 'primary',
      '#submit' => [
        [
          $helper,
          'importCustomBlocksSafe',
        ],
      ],
    ];
    $form['import']['import_blocks_full'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Import custom blocks (full)'),
      '#name' => 'importBlocksFull',
      '#submit' => [
        [
          $helper,
          'importCustomBlocksFull',
        ],
      ],
    ];
    $form['import']['import_blocks_force'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Import custom blocks (force)'),
      '#name' => 'importBlocksForce',
      '#submit' => [
        [
          $helper,
          'importCustomBlocksForce',
        ],
      ],
    ];
    $block_list_config = [];
    foreach ($block_list as $block) {
      if ($block['revision_id'] === $block['rev_id_current']) {
        $block_list_config[$block['uuid']] = $block['info'];
      }
    }
    $form['import']['import_block_list'] = [
      '#type' => 'checkboxes',
      '#options' => $block_list_config,
      '#default_value' => array_keys($block_list_config),
      '#title' => $this
        ->t('Select the custom blocks you would like to import'),
    ];
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlocksSyncForm::$database	protected	property	The database.
BlocksSyncForm::$entityTypeManager	protected	property
BlocksSyncForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
BlocksSyncForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
BlocksSyncForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
BlocksSyncForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
BlocksSyncForm::__construct	public	function	Class constructor. Overrides ConfigFormBase::__construct
ConfigFormBase::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm	26
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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 BlocksSyncForm in Structure Sync 8

Hierarchy

File

Namespace

Members

API Navigation