You are here

Home » API reference » Menu Import and Export 8 » MenuExportConfigurationForm.php

class MenuExportConfigurationForm in Menu Import and Export 8

Configure Menu Export settings.

Hierarchy

Expanded class hierarchy of MenuExportConfigurationForm

1 string reference to 'MenuExportConfigurationForm'
menu_export.routing.yml in ./menu_export.routing.yml
menu_export.routing.yml

File

src/Form/MenuExportConfigurationForm.php, line 13

Namespace

Drupal\menu_export\Form
View source 
class MenuExportConfigurationForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'menu_export.settings',
      'menu_export.export_data',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('menu_export.settings');
    $menuIds = \Drupal::entityQuery('menu')
      ->execute();
    $menuEntities = Menu::loadMultiple($menuIds);
    foreach ($menuEntities as $menu) {
      $menuNames[$menu
        ->id()] = $menu
        ->label();
    }
    $form['warning'] = [
      '#type' => 'markup',
      '#markup' => $this
        ->t('<strong>Caution:</strong> Select only the menus which are consistent in all the environments(dev,staging,prod).'),
    ];
    $form['menus'] = [
      '#title' => $this
        ->t('Menus to Export'),
      '#type' => 'checkboxes',
      '#options' => $menuNames,
      '#default_value' => $config
        ->get('menus') ? $config
        ->get('menus') : [],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * Custom form validation for menus.
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    foreach ($form_state
      ->getValue('menus') as $val) {
      if ($val) {
        $menu[] = $val;
      }
    }
    $form_state
      ->setValue('menus', $menu);
    return parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('menu_export.settings')
      ->set('menus', $form_state
      ->getValue('menus'))
      ->save();
    $this
      ->backupMenus($form_state
      ->getValue('menus'));
    parent::submitForm($form, $form_state);
  }
  protected function backupMenus($menus) {
    $config = $this
      ->config('menu_export.export_data');
    $config
      ->delete()
      ->save();
    if (empty($menus)) {
      return false;
    }
    foreach ($menus as $menu) {
      $menuLinkIds = \Drupal::entityQuery('menu_link_content')
        ->condition('menu_name', $menu)
        ->execute();
      $menuLinks = MenuLinkContent::loadMultiple($menuLinkIds);
      $saveMenu[] = '';
      foreach ($menuLinks as $link) {
        if (!empty($link)) {
          $linkArray = $link
            ->toArray();
          unset($linkArray['id']);
          foreach ($linkArray as $key => $linkArrayItem) {
            $linkData[$key] = reset($linkArrayItem);
          }
          $saveMenu[$link
            ->uuid()] = serialize($linkData);

          //$data[$link->id()] = $linkData;
          unset($linkData);
        }
      }
      $config
        ->set($menu, $saveMenu);
      unset($saveMenu);
    }
    $config
      ->save();
    return true;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
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.
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.
MenuExportConfigurationForm::backupMenus protected function
MenuExportConfigurationForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
MenuExportConfigurationForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
MenuExportConfigurationForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MenuExportConfigurationForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
MenuExportConfigurationForm::validateForm public function Custom form validation for menus. Overrides FormBase::validateForm
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.