You are here

Home » API reference » Features 8.3 » AssignmentExcludeForm.php

class AssignmentExcludeForm in Features 8.3

Same name and namespace in other branches
  1. 8.4 modules/features_ui/src/Form/AssignmentExcludeForm.php \Drupal\features_ui\Form\AssignmentExcludeForm

Configures the selected configuration assignment method for this site.

Hierarchy

Expanded class hierarchy of AssignmentExcludeForm

1 string reference to 'AssignmentExcludeForm'
features_ui.routing.yml in modules/features_ui/features_ui.routing.yml
modules/features_ui/features_ui.routing.yml

File

modules/features_ui/src/Form/AssignmentExcludeForm.php, line 15

Namespace

Drupal\features_ui\Form
View source 
class AssignmentExcludeForm extends AssignmentFormBase {
  const METHOD_ID = 'exclude';

  /**
   * The install profile extension list.
   *
   * @var \Drupal\Core\Extension\ExtensionList
   */
  protected $profileList;

  /**
   * The install profile.
   *
   * @var string
   */
  protected $installProfile;

  /**
   * Constructs a AssignmentExcludeForm object.
   *
   * @param \Drupal\Core\Extension\ExtensionList $extension_list
   *   The install profile extension list.
   * @param string $install_profile
   *   The install profile.
   * @param \Drupal\features\FeaturesManagerInterface $features_manager
   *   The features manager.
   * @param \Drupal\features\FeaturesAssignerInterface $assigner
   *   The assigner.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(FeaturesManagerInterface $features_manager, FeaturesAssignerInterface $assigner, EntityTypeManagerInterface $entity_type_manager, ExtensionList $profile_list, $install_profile) {
    parent::__construct($features_manager, $assigner, $entity_type_manager);
    $this->profileList = $profile_list;
    $this->installProfile = $install_profile;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('features.manager'), $container
      ->get('features_assigner'), $container
      ->get('entity_type.manager'), $container
      ->get('extension.list.profile'), $container
      ->getParameter('install_profile'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $bundle_name = NULL) {
    $this->currentBundle = $this->assigner
      ->loadBundle($bundle_name);
    $settings = $this->currentBundle
      ->getAssignmentSettings(self::METHOD_ID);
    $module_settings = $settings['module'];
    $curated_settings = $settings['curated'];
    $this
      ->setConfigTypeSelect($form, $settings['types']['config'], $this
      ->t('exclude'), FALSE, $this
      ->t("Select types of configuration that should be excluded from packaging."));
    $form['curated'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Exclude designated site-specific configuration'),
      '#default_value' => $curated_settings,
      '#description' => $this
        ->t('Select this option to exclude a curated list of site-specific configuration from packaging.'),
    ];
    $form['module'] = [
      '#type' => 'fieldset',
      '#tree' => TRUE,
      '#title' => $this
        ->t('Exclude configuration provided by modules'),
    ];
    $form['module']['installed'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Exclude installed module-provided entity configuration'),
      '#default_value' => $module_settings['installed'],
      '#description' => $this
        ->t('Select this option to exclude configuration provided by INSTALLED modules from reassignment.'),
      '#attributes' => [
        'data-module-installed' => 'status',
      ],
    ];
    $show_if_module_installed_checked = [
      'visible' => [
        ':input[data-module-installed="status"]' => [
          'checked' => TRUE,
        ],
      ],
    ];
    $info = $this->profileList
      ->getExtensionInfo($this->installProfile);
    $form['module']['profile'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Don't exclude install profile's configuration"),
      '#default_value' => $module_settings['profile'],
      '#description' => $this
        ->t("Select this option to allow configuration provided by the site's install profile (%profile) to be reassigned.", [
        '%profile' => $info['name'],
      ]),
      '#states' => $show_if_module_installed_checked,
    ];
    $bundle_name = $this->currentBundle
      ->getMachineName();
    $bundle_name = !empty($bundle_name) ? $bundle_name : $this
      ->t('none');
    $form['module']['namespace'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Don't exclude non-installed configuration by namespace"),
      '#default_value' => $module_settings['namespace'],
      '#description' => $this
        ->t("Select this option to allow configuration provided by uninstalled modules with the bundle namespace (%namespace_*) to be reassigned.", [
        '%namespace' => $bundle_name,
      ]),
      '#states' => $show_if_module_installed_checked,
      '#attributes' => [
        'data-namespace' => 'status',
      ],
    ];
    $show_if_namespace_checked = [
      'visible' => [
        ':input[data-namespace="status"]' => [
          'checked' => TRUE,
        ],
        ':input[data-module-installed="status"]' => [
          'checked' => TRUE,
        ],
      ],
    ];
    $form['module']['namespace_any'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Don't exclude ANY configuration by namespace"),
      '#default_value' => $module_settings['namespace_any'],
      '#description' => $this
        ->t("Select this option to allow configuration provided by ANY modules with the bundle namespace (%namespace_*) to be reassigned.\n        Warning: Can cause installed configuration to be reassigned to different packages.", [
        '%namespace' => $bundle_name,
      ]),
      '#states' => $show_if_namespace_checked,
    ];
    $this
      ->setActions($form, self::METHOD_ID);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setValue('types', array_map('array_filter', $form_state
      ->getValue('types')));
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Merge in selections.
    $settings = $this->currentBundle
      ->getAssignmentSettings(self::METHOD_ID);
    $settings = array_merge($settings, [
      'types' => $form_state
        ->getValue('types'),
      'curated' => $form_state
        ->getValue('curated'),
      'module' => $form_state
        ->getValue('module'),
    ]);
    $this->currentBundle
      ->setAssignmentSettings(self::METHOD_ID, $settings)
      ->save();
    $this
      ->setRedirect($form_state);
    $this
      ->messenger()
      ->addStatus($this
      ->t('Package assignment configuration saved.'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssignmentExcludeForm::$installProfile protected property The install profile.
AssignmentExcludeForm::$profileList protected property The install profile extension list.
AssignmentExcludeForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
AssignmentExcludeForm::create public static function Instantiates a new instance of this class. Overrides AssignmentFormBase::create
AssignmentExcludeForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AssignmentExcludeForm::METHOD_ID constant
AssignmentExcludeForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
AssignmentExcludeForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
AssignmentExcludeForm::__construct public function Constructs a AssignmentExcludeForm object. Overrides AssignmentFormBase::__construct
AssignmentFormBase::$assigner protected property The package assigner.
AssignmentFormBase::$currentBundle protected property The current bundle.
AssignmentFormBase::$entityTypeManager protected property The entity type manager.
AssignmentFormBase::$featuresManager protected property The features manager.
AssignmentFormBase::setActions protected function Adds a "Save settings" submit action.
AssignmentFormBase::setConfigTypeSelect protected function Adds configuration types checkboxes.
AssignmentFormBase::setContentTypeSelect protected function Adds content entity types checkboxes.
AssignmentFormBase::setRedirect protected function Redirects back to the Bundle config form.
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.