function ConditionForm::form

Overrides ExpressionFormInterface::form

File

src/Form/Expression/ConditionForm.php, line 45

Class

ConditionForm

UI form for adding/editing a Rules condition.

Namespace

Code

public function form(array $form, FormStateInterface $form_state) {
    $condition_id = $form_state->get('condition_id');
    $configuration = $this->conditionExpression
        ->getConfiguration();
    if (empty($condition_id) && !empty($configuration['condition_id'])) {
        $condition_id = $configuration['condition_id'];
        $form_state->set('condition_id', $condition_id);
    }
    // Step 1 of the multistep form.
    if (!$condition_id) {
        $condition_definitions = $this->conditionManager
            ->getGroupedDefinitions();
        $options = [];
        foreach ($condition_definitions as $group => $definitions) {
            foreach ($definitions as $id => $definition) {
                if ($group != $this->t('Other')) {
                    // Because core Conditions do not currently define some context
                    // values required by Rules, we need to make sure they can't be
                    // selected through the Rules UI. The Rules ConditionManager puts
                    // these core Conditions into the 'Other' group so that we can
                    // identify them and leave them off of the Condition selection
                    // form element below.
                    // @see https://www.drupal.org/project/rules/issues/2927132
                    $options[$group][$id] = $definition['label'];
                }
            }
        }
        $form['condition_id'] = [
            '#type' => 'select',
            '#title' => $this->t('Condition'),
            '#options' => $options,
            '#required' => TRUE,
        ];
        $form['continue'] = [
            '#type' => 'submit',
            '#value' => $this->t('Continue'),
            '#name' => 'continue',
            // Only validate the selected condition in the first step.
'#limit_validation_errors' => [
                [
                    'condition_id',
                ],
            ],
            '#submit' => [
                static::class . '::submitFirstStep',
            ],
        ];
        return $form;
    }
    // Step 2 of the form.
    
    /** @var \Drupal\rules\Core\RulesConditionInterface $condition */
    $condition = $this->conditionManager
        ->createInstance($condition_id);
    $form['summary'] = [
        '#type' => 'details',
        '#title' => $this->t('Summary'),
    ];
    $form['summary']['description'] = [
        '#type' => 'container',
        '#plain_text' => $this->t('Condition: @summary', [
            '@summary' => $condition->summary(),
        ]),
        '#attributes' => [
            'class' => [
                'form-item',
            ],
        ],
    ];
    $context_definitions = $condition->getContextDefinitions();
    if (!empty($context_definitions)) {
        $form['context_definitions'] = [
            '#type' => 'details',
            '#title' => $this->t('Context variables'),
            '#open' => TRUE,
            '#tree' => TRUE,
        ];
        foreach ($context_definitions as $context_name => $context_definition) {
            $form = $this->buildContextForm($form, $form_state, $context_name, $context_definition, $configuration);
        }
    }
    $provides_definitions = $condition->getProvidedContextDefinitions();
    if (!empty($provides_definitions)) {
        $form['provides'] = [
            '#type' => 'details',
            '#title' => $this->t('Provided variables'),
            '#description' => $this->t('You may change the name of any provided variables, but note that renaming already-utilized variables invalidates the existing uses.'),
            '#open' => TRUE,
        ];
        foreach ($provides_definitions as $provides_name => $provides_definition) {
            $form = $this->buildProvidedContextForm($form, $form_state, $provides_name, $provides_definition, $configuration);
        }
    }
    $form['negate_wrapper'] = [
        '#type' => 'fieldset',
        '#title' => $this->t('Negate'),
    ];
    $form['negate_wrapper']['negate'] = [
        '#type' => 'checkbox',
        '#title' => $this->t('Negate this condition'),
        '#default_value' => $configuration['negate'] ?: 0,
        '#description' => $this->t('If checked, the condition result is negated such that it returns TRUE if it evaluates to FALSE.'),
    ];
    $form['save'] = [
        '#type' => 'submit',
        '#value' => $this->t('Save'),
        '#name' => 'save',
    ];
    return $form;
}