You are here

Home » API reference » Chaos Tool Suite (ctools) 8.3 » ConditionConfigure.php

abstract class ConditionConfigure in Chaos Tool Suite (ctools) 8.3

Base class for condition configur operations.

Hierarchy

Expanded class hierarchy of ConditionConfigure

File

src/Form/ConditionConfigure.php, line 21

Namespace

Drupal\ctools\Form
View source 
abstract class ConditionConfigure extends FormBase {

  /**
   * @var \Drupal\Core\TempStore\SharedTempStoreFactory
   */
  protected $tempstore;

  /**
   * @var \Drupal\Core\Condition\ConditionManager
   */
  protected $manager;

  /**
   * @var string
   */
  protected $tempstore_id;

  /**
   * @var string
   */
  protected $machine_name;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('tempstore.shared'), $container
      ->get('plugin.manager.condition'));
  }
  public function __construct(SharedTempStoreFactory $tempstore, PluginManagerInterface $manager) {
    $this->tempstore = $tempstore;
    $this->manager = $manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $condition = NULL, $tempstore_id = NULL, $machine_name = NULL) {
    $this->tempstore_id = $tempstore_id;
    $this->machine_name = $machine_name;
    $cached_values = $this->tempstore
      ->get($this->tempstore_id)
      ->get($this->machine_name);
    if (is_numeric($condition) || Uuid::isValid($condition)) {
      $id = $condition;
      $condition = $this
        ->getConditions($cached_values)[$id];
      $instance = $this->manager
        ->createInstance($condition['id'], $condition);
    }
    else {
      $instance = $this->manager
        ->createInstance($condition, []);
    }
    $form_state
      ->setTemporaryValue('gathered_contexts', $this
      ->getContexts($cached_values));

    /** @var $instance \Drupal\Core\Condition\ConditionInterface */
    $form = $instance
      ->buildConfigurationForm($form, $form_state);
    if (isset($id)) {

      // Conditionally set this form element so that we can update or add.
      $form['id'] = [
        '#type' => 'value',
        '#value' => $id,
      ];
    }
    $form['instance'] = [
      '#type' => 'value',
      '#value' => $instance,
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#ajax' => [
        'callback' => [
          $this,
          'ajaxSave',
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $cached_values = $this->tempstore
      ->get($this->tempstore_id)
      ->get($this->machine_name);

    /** @var $instance \Drupal\Core\Condition\ConditionInterface */
    $instance = $form_state
      ->getValue('instance');
    $instance
      ->submitConfigurationForm($form, $form_state);
    $conditions = $this
      ->getConditions($cached_values);
    if ($instance instanceof ContextAwarePluginInterface) {

      /** @var  $instance \Drupal\Core\Plugin\ContextAwarePluginInterface */
      $context_mapping = $form_state
        ->hasValue('context_mapping') ? $form_state
        ->getValue('context_mapping') : [];
      $instance
        ->setContextMapping($context_mapping);
    }
    if ($instance instanceof ConstraintConditionInterface) {

      /** @var  $instance \Drupal\ctools\ConstraintConditionInterface */
      $instance
        ->applyConstraints($this
        ->getContexts($cached_values));
    }
    if ($form_state
      ->hasValue('id')) {
      $conditions[$form_state
        ->getValue('id')] = $instance
        ->getConfiguration();
    }
    else {
      $conditions[] = $instance
        ->getConfiguration();
    }
    $cached_values = $this
      ->setConditions($cached_values, $conditions);
    $this->tempstore
      ->get($this->tempstore_id)
      ->set($this->machine_name, $cached_values);
    list($route_name, $route_parameters) = $this
      ->getParentRouteInfo($cached_values);
    $form_state
      ->setRedirect($route_name, $route_parameters);
  }
  public function ajaxSave(array &$form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    $cached_values = $this->tempstore
      ->get($this->tempstore_id)
      ->get($this->machine_name);
    list($route_name, $route_parameters) = $this
      ->getParentRouteInfo($cached_values);
    $url = Url::fromRoute($route_name, $route_parameters);
    $response
      ->addCommand(new RedirectCommand($url
      ->toString()));
    $response
      ->addCommand(new CloseModalDialogCommand());
    return $response;
  }

  /**
   * Document the route name and parameters for redirect after submission.
   *
   * @param $cached_values
   *
   * @return array
   *   In the format of
   *   return ['route.name', ['machine_name' => $this->machine_name, 'step' => 'step_name']];
   */
  protected abstract function getParentRouteInfo($cached_values);

  /**
   * Custom logic for retrieving the conditions array from cached_values.
   *
   * @param $cached_values
   *
   * @return array
   */
  protected abstract function getConditions($cached_values);

  /**
   * Custom logic for setting the conditions array in cached_values.
   *
   * @param $cached_values
   *
   * @param $conditions
   *   The conditions to set within the cached values.
   *
   * @return mixed
   *   Return the $cached_values
   */
  protected abstract function setConditions($cached_values, $conditions);

  /**
   * Custom logic for retrieving the contexts array from cached_values.
   *
   * @param $cached_values
   *
   * @return \Drupal\Core\Plugin\Context\ContextInterface[]
   */
  protected abstract function getContexts($cached_values);

}

Members

Namesort descending Modifiers Type Description Overrides
ConditionConfigure::$machine_name protected property
ConditionConfigure::$manager protected property
ConditionConfigure::$tempstore protected property
ConditionConfigure::$tempstore_id protected property
ConditionConfigure::ajaxSave public function
ConditionConfigure::buildForm public function Form constructor. Overrides FormInterface::buildForm
ConditionConfigure::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ConditionConfigure::getConditions abstract protected function Custom logic for retrieving the conditions array from cached_values.
ConditionConfigure::getContexts abstract protected function Custom logic for retrieving the contexts array from cached_values.
ConditionConfigure::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConditionConfigure::getParentRouteInfo abstract protected function Document the route name and parameters for redirect after submission.
ConditionConfigure::setConditions abstract protected function Custom logic for setting the conditions array in cached_values.
ConditionConfigure::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ConditionConfigure::__construct public function
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.