You are here

class ConditionCreatorForm in Block Visibility Groups 8

Provides a form to create conditions.

Hierarchy

Expanded class hierarchy of ConditionCreatorForm

1 string reference to 'ConditionCreatorForm'
block_visibility_groups_admin.routing.yml in block_visibility_groups_admin/block_visibility_groups_admin.routing.yml
block_visibility_groups_admin/block_visibility_groups_admin.routing.yml

File

block_visibility_groups_admin/src/Form/ConditionCreatorForm.php, line 15

Namespace

Drupal\block_visibility_groups_admin\Form
View source
class ConditionCreatorForm extends FormBase {

  /**
   * The condition plugin manager.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $manager;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.block_visibility_groups_admin.condition_creator'));
  }

  /**
   * ConditionCreatorForm constructor.
   *
   * @param \Drupal\Component\Plugin\PluginManagerInterface $manager
   */
  public function __construct(PluginManagerInterface $manager) {
    $this->manager = $manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $route_name = NULL, $parameters = NULL) {
    $parameters = Json::decode($parameters);
    if (empty($route_name)) {

      // @todo Throw error
    }
    $form['label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Label'),
      '#maxlength' => 255,
      '#description' => $this
        ->t("Label for the Block Visibility Group."),
      '#required' => TRUE,
    ];
    $form['id'] = [
      '#type' => 'machine_name',
      '#machine_name' => [
        'exists' => '\\Drupal\\block_visibility_groups\\Entity\\BlockVisibilityGroup::load',
      ],
    ];
    $form['conditions'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Conditions'),
      '#description' => $this
        ->t('Select at least one condition that applies to the current page.'),
    ];
    $form['conditions'] += $this
      ->conditionOptions($route_name, $parameters);
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Create new Group'),
    ];
    $form['route_name'] = [
      '#type' => 'value',
      '#value' => $route_name,
    ];
    $form['parameters'] = [
      '#type' => 'value',
      '#value' => $parameters,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  protected function conditionOptions($route_name, $parameters) {
    $elements = [
      '#tree' => TRUE,
    ];
    $this->manager
      ->getDefinitions();
    $definitions = $this->manager
      ->getDefinitions();
    foreach ($definitions as $id => $info) {

      /** @var \Drupal\block_visibility_groups_admin\Plugin\ConditionCreatorInterface $creator */
      $creator = $this->manager
        ->createInstance($id, [
        'route_name' => $route_name,
        'parameters' => $parameters,
      ]);
      if ($creator
        ->getNewConditionLabel()) {
        $elements[$id] = $creator
          ->createConditionElements();
      }
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $conditions = $this
      ->getConditionValues($form_state);
    $route_name = $form_state
      ->getValue('route_name');
    $parameters = $form_state
      ->getValue('parameters');
    foreach ($conditions as $plugin_id => $plugin_info) {

      /** @var \Drupal\block_visibility_groups_admin\Plugin\ConditionCreatorInterface $plugin */
      $plugin = $this->manager
        ->createInstance($plugin_id, [
        'route_name' => $route_name,
        'parameters' => $parameters,
      ]);
      if ($plugin
        ->itemSelected($plugin_info)) {

        // At least 1 condition setting selected.
        return;
      }
    }
    $form_state
      ->setErrorByName('conditions', $this
      ->t('At least one condition must be selected'));
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $id = $form_state
      ->getValue('id');
    $label = $form_state
      ->getValue('label');
    $route_name = $form_state
      ->getValue('route_name');
    $conditions = $this
      ->getConditionValues($form_state);
    $configs = [];
    foreach ($conditions as $plugin_id => $plugin_info) {

      /** @var \Drupal\block_visibility_groups_admin\Plugin\ConditionCreatorInterface $plugin */
      $plugin = $this->manager
        ->createInstance($plugin_id, [
        'route_name' => $route_name,
      ]);
      if ($plugin
        ->itemSelected($plugin_info)) {
        $configs[] = $plugin
          ->createConditionConfig($plugin_info);
      }
    }
    $group = $this
      ->createGroup($id, $label, $configs);
    $form_state
      ->setRedirect('entity.block_visibility_group.edit_form', [
      'block_visibility_group' => $group
        ->id(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  protected function getConditionValues(FormStateInterface $form_state) {
    return $form_state
      ->cleanValues()
      ->getValue('conditions');
  }

  /**
   * Create group.
   *
   * @param $id
   * @param $label
   * @param $configs
   *
   * @return \Drupal\block_visibility_groups\Entity\BlockVisibilityGroup
   */
  protected function createGroup($id, $label, $configs) {

    /** @var \Drupal\block_visibility_groups\Entity\BlockVisibilityGroup $group */
    $group = BlockVisibilityGroup::create([
      'id' => $id,
      'label' => $label,
    ]);
    $group
      ->save();
    foreach ($configs as $config) {
      $group
        ->addCondition($config);
    }
    $group
      ->save();
    return $group;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConditionCreatorForm::$manager protected property The condition plugin manager.
ConditionCreatorForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
ConditionCreatorForm::conditionOptions protected function
ConditionCreatorForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ConditionCreatorForm::createGroup protected function Create group.
ConditionCreatorForm::getConditionValues protected function
ConditionCreatorForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConditionCreatorForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ConditionCreatorForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
ConditionCreatorForm::__construct public function ConditionCreatorForm constructor.
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.