class DrupalConfigHelper in Backup and Migrate 5.0.x

@package Drupal\backup_migrate\Drupal\Config

Hierarchy

• class \Drupal\backup_migrate\Drupal\Config\DrupalConfigHelper

7 files declare their use of DrupalConfigHelper

BackupMigrateAdvancedBackupForm.php in src/Form/BackupMigrateAdvancedBackupForm.php

BackupMigrateQuickBackupForm.php in src/Form/BackupMigrateQuickBackupForm.php

BackupMigrateRestoreForm.php in src/Form/BackupMigrateRestoreForm.php

BackupRestoreForm.php in src/Form/BackupRestoreForm.php

ScheduleForm.php in src/Form/ScheduleForm.php

... See full list

File

src/Drupal/Config/DrupalConfigHelper.php, line 18

Namespace

Drupal\backup_migrate\Drupal\Config

class DrupalConfigHelper {

  /**
   * Build the configuration form for all plugins in a manager.
   *
   * @param \Drupal\backup_migrate\Core\Plugin\PluginManagerInterface $plugins
   *   The PluginManager containing all of the plugins to be configured.
   * @param string $operation
   *   'backup', 'restore', or 'initialize' depending on the operation being
   *   configured for.
   * @param array $parents
   *   The form parents array.
   *
   * @return array
   */
  public static function buildAllPluginsForm(PluginManagerInterface $plugins, $operation, array $parents = []) {
    $form = [];
    foreach ($plugins
      ->getAll() as $plugin_key => $plugin) {
      $schema = $plugin
        ->configSchema([
        'operation' => $operation,
      ]);
      $config = $plugin
        ->config();
      DrupalConfigHelper::addFieldsFromSchema($form, $schema, $config, array_merge($parents, [
        $plugin_key,
      ]));
    }
    return $form;
  }

  /**
   * Build the configuration form for a single plugin, source or destination.
   *
   * @param DrupalDirectoryDestination|FileDirectorySource|MySQLiSource $plugin
   *   The plugin, source or destination to build the form for.
   * @param string $operation
   *   'backup', 'restore', or 'initialize' depending on the operation being
   *   configured for.
   * @param array $parents
   *
   * @return array
   */
  public static function buildPluginForm($plugin, $operation, array $parents = [
    'config',
  ]) {
    $schema = $plugin
      ->configSchema([
      'operation' => $operation,
    ]);
    $config = $plugin
      ->config();
    return DrupalConfigHelper::buildFormFromSchema($schema, $config, $parents);
  }

  /**
   * @param array $schema
   *   A configuration schema from one or more Backup and Migrate plugins.
   * @param \Drupal\backup_migrate\Core\Config\ConfigInterface $config
   *   The configuration object containing the default values.
   * @param array $parents
   *   The form parents array.
   *
   * @return array
   *   A drupal forms api array.
   */
  public static function buildFormFromSchema(array $schema, ConfigInterface $config, array $parents = []) {
    $form = [];
    DrupalConfigHelper::addFieldsFromSchema($form, $schema, $config, $parents);
    return $form;
  }

  /**
   * Add the schema fields to the given form array.
   *
   * @param array $form
   *   The form structure being worked on.
   * @param array $schema
   *   A configuration schema from one or more Backup and Migrate plugins.
   * @param \Drupal\backup_migrate\Core\Config\ConfigInterface $config
   *   The configuration object containing the default values.
   * @param array $parents
   *   The form parents array.
   */
  public static function addFieldsFromSchema(array &$form, array $schema, ConfigInterface $config, array $parents = []) {

    // Add the specified groups.
    if (isset($schema['groups'])) {
      foreach ($schema['groups'] as $group_key => $item) {

        // If the group is just called 'default' then use the key from the
        // plugin as the group key.
        // @todo Make this less ugly.
        if ($group_key == 'default' && $parents) {
          $group_key = end($parents);
        }
        if (!isset($form[$group_key])) {
          $form[$group_key] = [
            '#type' => 'fieldset',
            '#title' => $item['title'],
            '#tree' => FALSE,
          ];
        }
      }
    }

    // Add each of the fields.
    if (isset($schema['fields'])) {
      foreach ($schema['fields'] as $field_key => $item) {
        $form_item = [];
        $value = $config
          ->get($field_key);
        switch ($item['type']) {
          case 'text':
            $form_item['#type'] = 'textfield';
            if (!empty($item['multiple'])) {
              $form_item['#type'] = 'textarea';
              if (!isset($form_item['#description'])) {
                $form_item['#description'] = '';
              }
              if (!empty($form_item['#description'])) {
                $form_item['#description'] .= ' ';
              }
              $form_item['#description'] .= t('Add one item per line.');
              $form_item['#element_validate'] = [
                'Drupal\\backup_migrate\\Drupal\\Config\\DrupalConfigHelper::validateMultiText',
              ];
              $value = implode("\n", $value);
            }
            if (!empty($item['multiline'])) {
              $form_item['#type'] = 'textarea';
            }
            break;
          case 'password':
            $form_item['#type'] = 'password';
            $form_item['#value_callback'] = 'Drupal\\backup_migrate\\Drupal\\Config\\DrupalConfigHelper::valueCallbackSecret';
            break;
          case 'number':
            $form_item['#type'] = 'textfield';
            $form_item['#size'] = 5;
            if (!empty($item['max'])) {
              $form_item['#size'] = strlen((string) $item['max']) + 3;
            }
            break;
          case 'boolean':
            $form_item['#type'] = 'checkbox';
            break;
          case 'enum':
            $form_item['#type'] = 'select';
            $form_item['#multiple'] = !empty($item['multiple']);
            if (empty($item['#required']) && empty($item['multiple'])) {
              $item['options'] = [
                '' => '--' . t('None') . '--',
              ] + $item['options'];
            }
            $form_item['#options'] = $item['options'];
            break;
        }

        // If there is a form item add it to the form.
        if ($form_item) {

          // Add the common form elements.
          $form_item['#title'] = $item['title'];
          $form_item['#parents'] = array_merge($parents, [
            $field_key,
          ]);
          $form_item['#required'] = !empty($item['required']);
          $form_item['#default_value'] = $value;
          if (!empty($item['description'])) {
            $form_item['#description'] = $item['description'];
          }

          // Add the field to it's group or directly to the top level of the
          // form.
          if (!empty($item['group'])) {
            $group_key = $item['group'];
            if ($group_key == 'default' && $parents) {
              $group_key = end($parents);
            }
            $form[$group_key][$field_key] = $form_item;
          }
          else {
            $form[$field_key] = $form_item;
          }
        }
      }
    }
  }

  /**
   * Break a multi-line text value into an array.
   *
   * @param array $element
   * @param $form_state
   */
  public static function validateMultiText(array &$element, FormStateInterface &$form_state) {
    $form_state
      ->setValueForElement($element, array_map('trim', explode("\n", $element['#value'])));
  }

  /**
   * Replaces missing secrets.
   *
   * A value mapping callback. Because the Form API does not preserve the
   * default values of password inputs.
   *
   * @param $element
   * @param $input
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   */
  public static function valueCallbackSecret(&$element, $input, FormStateInterface $form_state) {
    if (empty($input)) {
      return $element['#default_value'];
    }
    return $input;
  }

  /**
   * Get a pulldown for the given list of plugins.
   *
   * @param \Drupal\backup_migrate\Core\Config\ConfigurableInterface[]|\Drupal\backup_migrate\Core\Plugin\PluginManagerInterface $plugins
   * @param $title
   * @param $default_value
   *
   * @return array
   */
  public static function getPluginSelector(PluginManagerInterface $plugins, $title, $default_value = NULL) {
    $options = [];
    foreach ($plugins
      ->getAll() as $key => $plugin) {
      $options[$key] = $plugin
        ->confGet('name', $key);
    }
    return [
      '#type' => 'select',
      '#title' => $title,
      '#options' => $options,
      '#default_value' => $default_value,
    ];
  }

  /**
   * Get a select form item for the given list of sources.
   *
   * @param \Drupal\backup_migrate\Core\Main\BackupMigrateInterface $bam
   * @param $title
   * @param $default_value
   *
   * @return array
   */
  public static function getSourceSelector(BackupMigrateInterface $bam, $title, $default_value = NULL) {
    return DrupalConfigHelper::getPluginSelector($bam
      ->sources(), $title, $default_value);
  }

  /**
   * Get a select form item for the given list of sources.
   *
   * @param \Drupal\backup_migrate\Core\Main\BackupMigrateInterface $bam
   * @param string $title
   * @param mixed $default_value
   *
   * @return array
   */
  public static function getDestinationSelector(BackupMigrateInterface $bam, $title, $default_value = NULL) {
    return DrupalConfigHelper::getPluginSelector($bam
      ->destinations(), $title, $default_value);
  }

  /**
   * Get a pulldown for the list of all settings profiles.
   *
   * @param string $title
   * @param mixed $default_value
   *
   * @return array
   */
  public static function getSettingsProfileSelector($title, $default_value = NULL) {
    $options = [];
    foreach (SettingsProfile::loadMultiple() as $key => $profile) {
      $options[$key] = $profile
        ->get('label');
    }
    if ($options) {
      return [
        '#type' => 'select',
        '#title' => $title,
        '#options' => $options,
        '#default_value' => $default_value,
      ];
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DrupalConfigHelper::addFieldsFromSchema	public static	function	Add the schema fields to the given form array.
DrupalConfigHelper::buildAllPluginsForm	public static	function	Build the configuration form for all plugins in a manager.
DrupalConfigHelper::buildFormFromSchema	public static	function
DrupalConfigHelper::buildPluginForm	public static	function	Build the configuration form for a single plugin, source or destination.
DrupalConfigHelper::getDestinationSelector	public static	function	Get a select form item for the given list of sources.
DrupalConfigHelper::getPluginSelector	public static	function	Get a pulldown for the given list of plugins.
DrupalConfigHelper::getSettingsProfileSelector	public static	function	Get a pulldown for the list of all settings profiles.
DrupalConfigHelper::getSourceSelector	public static	function	Get a select form item for the given list of sources.
DrupalConfigHelper::validateMultiText	public static	function	Break a multi-line text value into an array.
DrupalConfigHelper::valueCallbackSecret	public static	function	Replaces missing secrets.