You are here

Home » API reference » Context 8 » ContextEditForm.php

class ContextEditForm in Context 8

Same name and namespace in other branches
  1. 8.4 modules/context_ui/src/Form/ContextEditForm.php \Drupal\context_ui\Form\ContextEditForm
  2. 8.0 modules/context_ui/src/Form/ContextEditForm.php \Drupal\context_ui\Form\ContextEditForm

Hierarchy

Expanded class hierarchy of ContextEditForm

File

modules/context_ui/src/Form/ContextEditForm.php, line 11

Namespace

Drupal\context_ui\Form
View source 
class ContextEditForm extends ContextFormBase {
  use AjaxFormTrait;

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);

    // Store contexts on the form state so that plugins can use these values
    // when building their forms.
    $form_state
      ->setTemporaryValue('gathered_contexts', $this->contextRepository
      ->getAvailableContexts());
    $form['require_all_conditions'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Require all conditions'),
      '#description' => $this
        ->t('If checked, all conditions must be met for this context to be active. Otherwise, the first condition that is met will activate this context.'),
      '#default_value' => $this->entity
        ->requiresAllConditions(),
    ];
    $form['conditions'] = [
      '#prefix' => '<div id="context-conditions">',
      '#suffix' => '</div>',
      '#markup' => '<h3>' . $this
        ->t('Conditions') . '</h3>',
      '#tree' => TRUE,
      '#process' => array(
        array(
          $this,
          'processConditions',
        ),
      ),
    ];
    $form['reactions'] = [
      '#prefix' => '<div id="context-reactions">',
      '#suffix' => '</div>',
      '#markup' => '<h3>' . $this
        ->t('Reactions') . '</h3>',
      '#tree' => TRUE,
      '#process' => array(
        array(
          $this,
          'processReactions',
        ),
      ),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $formState) {
    $status = parent::save($form, $formState);
    if ($status) {
      drupal_set_message($this
        ->t('The context %label has been saved.', [
        '%label' => $this->entity
          ->getLabel(),
      ]));
    }
    else {
      drupal_set_message($this
        ->t('The context was not saved.'));
    }
  }

  /**
   * Process function for the conditions.
   *
   * @param $element
   *   The element to process.
   *
   * @param FormStateInterface $form_state
   *   The current form state.
   *
   * @return array
   */
  public function processConditions(&$element, FormStateInterface $form_state) {
    $conditions = $this->entity
      ->getConditions();
    $element['add_condition'] = array(
      '#type' => 'link',
      '#title' => $this
        ->t('Add condition'),
      '#url' => Url::fromRoute('context.conditions_library', [
        'context' => $this->entity
          ->id(),
      ]),
      '#attributes' => [
        'class' => [
          'use-ajax',
          'button',
          'button--small',
        ],
        'data-dialog-type' => 'modal',
        'data-dialog-options' => Json::encode([
          'width' => 700,
        ]),
      ],
    );
    if (!count($conditions)) {
      $element['reactions']['empty'] = [
        '#type' => 'container',
        '#markup' => $this
          ->t('No conditions has been added. When there are no added conditions the context will be considered sitewide.'),
      ];
    }
    $element['condition_tabs'] = [
      '#type' => 'vertical_tabs',
      '#parents' => [
        'condition_tabs',
      ],
    ];
    foreach ($conditions as $condition_id => $condition) {
      $element['condition-' . $condition_id] = [
        '#type' => 'details',
        '#title' => $condition
          ->getPluginDefinition()['label'],
        '#group' => 'condition_tabs',
      ];
      $element['condition-' . $condition_id]['options'] = $condition
        ->buildConfigurationForm([], $form_state);
      $element['condition-' . $condition_id]['options']['#parents'] = [
        'conditions',
        $condition_id,
      ];
      $element['condition-' . $condition_id]['remove'] = [
        '#type' => 'link',
        '#title' => $this
          ->t('Remove condition'),
        '#url' => Url::fromRoute('context.condition_delete', [
          'context' => $this->entity
            ->id(),
          'condition_id' => $condition_id,
        ]),
        '#attributes' => [
          'class' => [
            'use-ajax',
            'button',
            'button--small',
          ],
          'data-dialog-type' => 'modal',
          'data-dialog-options' => Json::encode([
            'width' => 700,
          ]),
        ],
      ];
    }
    return $element;
  }

  /**
   * Process function for the reactions.
   *
   * @param $element
   *   The element to process.
   *
   * @param FormStateInterface $form_state
   *   The current form state.
   *
   * @return array
   */
  public function processReactions(&$element, FormStateInterface $form_state) {
    $reactions = $this->entity
      ->getReactions();
    $element['add_reaction'] = [
      '#type' => 'link',
      '#title' => $this
        ->t('Add reaction'),
      '#url' => Url::fromRoute('context.reactions_library', [
        'context' => $this->entity
          ->id(),
      ]),
      '#attributes' => [
        'class' => [
          'use-ajax',
          'button',
          'button--small',
        ],
        'data-dialog-type' => 'modal',
        'data-dialog-options' => Json::encode([
          'width' => 700,
        ]),
      ],
    ];
    if (!count($reactions)) {
      $element['empty'] = [
        '#type' => 'container',
        '#markup' => $this
          ->t('No reactions has been added.'),
      ];
    }
    $element['reaction_tabs'] = [
      '#type' => 'vertical_tabs',
      '#parents' => [
        'reaction_tabs',
      ],
    ];
    foreach ($reactions as $reaction_id => $reaction) {
      $element['reaction-' . $reaction_id] = [
        '#type' => 'details',
        '#title' => $reaction
          ->getPluginDefinition()['label'],
        '#group' => 'reaction_tabs',
      ];
      $reaction_values = $form_state
        ->getValue([
        'reactions',
        $reaction_id,
      ], []);
      $reaction_state = (new FormState())
        ->setValues($reaction_values);
      $element['reaction-' . $reaction_id]['options'] = $reaction
        ->buildConfigurationForm([], $reaction_state, $this->entity);
      $element['reaction-' . $reaction_id]['options']['#parents'] = [
        'reactions',
        $reaction_id,
      ];
      $element['reaction-' . $reaction_id]['remove'] = [
        '#type' => 'link',
        '#title' => $this
          ->t('Remove reaction'),
        '#url' => Url::fromRoute('context.reaction_delete', [
          'context' => $this->entity
            ->id(),
          'reaction_id' => $reaction_id,
        ]),
        '#attributes' => [
          'class' => [
            'use-ajax',
            'button',
            'button--small',
          ],
          'data-dialog-type' => 'modal',
          'data-dialog-options' => Json::encode([
            'width' => 700,
          ]),
        ],
      ];
    }
    return $element;
  }

  /**
   * Actions function.
   *
   * @param array $form
   *   Form object.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state object.
   *
   * @return mixed
   *   Return mixed object.
   */
  protected function actions(array $form, FormStateInterface $form_state) {
    $element = parent::actions($form, $form_state);
    $element['submit'] = [
      '#type' => 'submit',
      '#dropbutton' => 'save',
      '#value' => t('Save and continue'),
      '#submit' => [
        '::submitForm',
        '::save',
      ],
    ];
    $element['submit_exit'] = [
      '#type' => 'submit',
      '#dropbutton' => 'save',
      '#value' => t('Save and exit'),
      '#submit' => [
        '::submitForm',
        '::save',
        '::collection',
      ],
    ];
    return $element;
  }

  /**
   * Collection function makes redirection to route name.
   *
   * @param array $form
   *   Form object.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   From state object.
   */
  public function collection(array $form, FormStateInterface $form_state) {
    $form_state
      ->setRedirect('entity.context.collection');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AjaxFormTrait::getAjaxAttributes public static function Gets attributes for use with an AJAX modal.
AjaxFormTrait::getAjaxButtonAttributes public static function Gets attributes for use with an add button AJAX modal.
ContextEditForm::actions protected function Actions function. Overrides EntityForm::actions
ContextEditForm::collection public function Collection function makes redirection to route name.
ContextEditForm::form public function Gets the actual form array to be built. Overrides ContextFormBase::form
ContextEditForm::processConditions public function Process function for the conditions.
ContextEditForm::processReactions public function Process function for the reactions.
ContextEditForm::save public function Form submission handler for the 'save' action. Overrides EntityForm::save
ContextFormBase::$contextManager protected property The Context module context manager.
ContextFormBase::$contextRepository protected property The Drupal context repository.
ContextFormBase::$entity protected property The entity being used by this form. Overrides EntityForm::$entity
ContextFormBase::contextExists public function Check to see if a context already exists with the specified name.
ContextFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ContextFormBase::handleConditions private function Handle submitting the condition plugins configuration forms.
ContextFormBase::handleReactions private function Handle submitting the context reaction plugins configuration forms.
ContextFormBase::submitForm public function This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides EntityForm::submitForm
ContextFormBase::validateForm public function Form validation handler. Overrides FormBase::validateForm
ContextFormBase::validateReactions private function Validate the context reaction plugins configuration forms.
ContextFormBase::__construct function Construct a new context 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
EntityForm::$entityTypeManager protected property The entity type manager. 3
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::$privateEntityManager private property The entity manager.
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 2
EntityForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 10
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties 7
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 5
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 1
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 10
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init protected function Initialize the form state and the entity before the first form build. 3
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager public function Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::__get public function
EntityForm::__set public function
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.