You are here

Home » API reference » CMS Content Sync 2.1.x » PoolAssignmentForm.php

class PoolAssignmentForm in CMS Content Sync 2.1.x

Same name and namespace in other branches
  1. 8 src/Form/PoolAssignmentForm.php \Drupal\cms_content_sync\Form\PoolAssignmentForm
  2. 2.0.x src/Form/PoolAssignmentForm.php \Drupal\cms_content_sync\Form\PoolAssignmentForm

Hierarchy

Expanded class hierarchy of PoolAssignmentForm

1 string reference to 'PoolAssignmentForm'
cms_content_sync.routing.yml in ./cms_content_sync.routing.yml
cms_content_sync.routing.yml

File

src/Form/PoolAssignmentForm.php, line 12

Namespace

Drupal\cms_content_sync\Form
View source 
class PoolAssignmentForm extends FormBase {
  public const STEP_SELECT_FLOW = 'flow';
  public const STEP_SELECT_POOL = 'pool';
  public const STEP_SELECT_ASSIGNMENT = 'assignment';
  protected $step;
  public function __construct() {
    $this->step = self::STEP_SELECT_FLOW;
  }
  public function getFormId() {
    return 'content_sync_pool_assignment_form';
  }
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['description'] = [
      '#type' => 'item',
      '#markup' => $this
        ->t('This form allows you to change a pool assignment within a Flow. You can change per Pool per Flow whether the assignment should be Allow, Force or Forbid across all entity types to make changing pool assignments faster than having to go through every entity type individually via the Flow edit form.'),
    ];
    $form['wrapper'] = [
      '#type' => 'container',
      '#attributes' => [
        'id' => 'form-wrapper',
      ],
    ];
    $flow_id = $form_state
      ->getValue('flow');
    $pool_id = $form_state
      ->getValue('pool');
    $next_step = null;
    $flows = Flow::getAll(false);
    $options = [];
    foreach ($flows as $flow) {
      if (Flow::TYPE_BOTH === $flow->type) {
        continue;
      }
      if (Flow::VARIANT_PER_BUNDLE !== $flow->variant) {
        continue;
      }
      $options[$flow->id] = $flow->name;
    }
    $form['wrapper']['flow'] = [
      '#type' => 'select',
      '#options' => $options,
      '#title' => $this
        ->t('Flow'),
      '#required' => true,
      '#default_value' => $flow_id,
      '#disabled' => self::STEP_SELECT_FLOW !== $this->step,
      '#description' => $this
        ->t('Please note that this only works for Flows that are either pulling or pushing but not both.'),
    ];
    if (self::STEP_SELECT_FLOW === $this->step) {
      $next_step = self::STEP_SELECT_POOL;
    }
    else {
      $pools = Pool::getAll();
      $options = [];
      foreach ($pools as $pool) {
        $options[$pool->id] = $pool->label;
      }
      $form['wrapper']['pool'] = [
        '#type' => 'select',
        '#options' => $options,
        '#title' => $this
          ->t('Pool'),
        '#required' => true,
        '#default_value' => $pool_id,
        '#disabled' => self::STEP_SELECT_POOL !== $this->step,
      ];
      if (self::STEP_SELECT_POOL === $this->step) {
        $next_step = self::STEP_SELECT_ASSIGNMENT;
      }
      else {
        $flow = $flows[$flow_id];
        $type = $flow->type;
        $pool_index = Flow::TYPE_PUSH === $type ? 'export_pools' : 'import_pools';
        $usages = [];
        foreach ($flow
          ->getController()
          ->getEntityTypeConfig() as $bundles) {
          foreach ($bundles as $config) {
            if (!isset($config[$pool_index][$pool_id])) {
              continue;
            }
            $usage = $config[$pool_index][$pool_id];
            if (in_array($usage, $usages)) {
              continue;
            }
            $usages[] = $usage;
          }
        }
        $options = [
          Pool::POOL_USAGE_ALLOW => 'allow',
          Pool::POOL_USAGE_FORCE => 'force',
          Pool::POOL_USAGE_FORBID => 'forbid',
        ];
        if (!count($usages)) {
          $empty = 'Currently: Unassigned';
        }
        elseif (1 === count($usages)) {
          $empty = 'Currently: ' . $usages[0];

          // No need to apply the same value.
          unset($options[$usages[0]]);
        }
        else {
          $empty = 'Currently: mixed (' . implode(', ', $usages) . ')';
        }
        $form['wrapper']['assignment'] = [
          '#empty_option' => $empty,
          '#type' => 'select',
          '#options' => $options,
          '#title' => $this
            ->t('Assignment (' . $type . ')'),
          '#required' => true,
          '#default_value' => null,
        ];
      }
    }
    $is_simple = $flow->variant === Flow::VARIANT_SIMPLE;
    if ($is_simple) {
      \Drupal::messenger()
        ->addWarning("This is only useful for per-bundle configurations. To edit the Pools of this Flow, please open the Flow form instead.");
    }
    if ($next_step) {
      $form['wrapper']['actions'] = [
        '#type' => 'actions',
      ];
      $form['wrapper']['actions']['continue'] = [
        '#type' => 'submit',
        '#next_step' => $next_step,
        '#value' => $this
          ->t('Continue'),
        '#disabled' => $is_simple,
        '#ajax' => [
          'callback' => [
            $this,
            'loadStep',
          ],
          'wrapper' => 'form-wrapper',
          'effect' => 'fade',
        ],
      ];
    }
    else {
      $form['wrapper']['actions'] = [
        '#type' => 'actions',
      ];
      $form['wrapper']['actions']['submit'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Change assignment'),
        '#submit' => [
          '::submitValues',
        ],
        '#disabled' => $is_simple,
      ];
    }
    return $form;
  }
  public function loadStep(array &$form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    $response
      ->addCommand(new HtmlCommand('#form-wrapper', $form['wrapper']));
    return $response;
  }
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
  }
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $triggering_element = $form_state
      ->getTriggeringElement();
    if (isset($triggering_element['#next_step'])) {
      $this->step = $triggering_element['#next_step'];
      $form_state
        ->setRebuild(true);
    }
  }
  public function submitValues(array &$form, FormStateInterface $form_state) {
    $flow_id = $form_state
      ->getValue('flow');
    $pool_id = $form_state
      ->getValue('pool');
    $assignment = $form_state
      ->getValue('assignment');
    $flow = Flow::getAll(false)[$flow_id];
    $type = $flow->type;
    $pool_index = Flow::TYPE_PUSH === $type ? 'export_pools' : 'import_pools';
    foreach ($flow
      ->getController()
      ->getEntityTypeConfig() as $entity_type_name => $bundles) {
      foreach ($bundles as $bundle_name => $config) {
        if (!isset($config[$pool_index])) {
          continue;
        }

        /**
         * @var FlowControllerPerBundle $controller
         */
        $controller = $flow
          ->getController();
        $controller
          ->setPool($entity_type_name, $bundle_name, $pool_index, $pool_id, $assignment);
        $config[$pool_index][$pool_id] = $assignment;
      }
    }
    $flow
      ->save();
    \Drupal::messenger()
      ->addStatus($this
      ->t('Updated pool assignment and saved the Flow.'));
    \Drupal::messenger()
      ->addWarning($this
      ->t('Please export the Flow to apply the changes.'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
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. 3
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 105
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.
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.
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PoolAssignmentForm::$step protected property
PoolAssignmentForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
PoolAssignmentForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PoolAssignmentForm::loadStep public function
PoolAssignmentForm::STEP_SELECT_ASSIGNMENT public constant
PoolAssignmentForm::STEP_SELECT_FLOW public constant
PoolAssignmentForm::STEP_SELECT_POOL public constant
PoolAssignmentForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
PoolAssignmentForm::submitValues public function
PoolAssignmentForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
PoolAssignmentForm::__construct public function
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. 4
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.