You are here

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

abstract class ContextConfigure in Chaos Tool Suite (ctools) 8.3

Hierarchy

Expanded class hierarchy of ContextConfigure

File

src/Form/ContextConfigure.php, line 20

Namespace

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

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

  /**
   * Object EntityTypeManager.
   *
   * @var Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * @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('entity_type.manager'));
  }
  public function __construct(SharedTempStoreFactory $tempstore, EntityTypeManagerInterface $entity_type_manager) {
    $this->tempstore = $tempstore;
    $this->entityTypeManager = $entity_type_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $context_id = 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);
    $contexts = $this
      ->getContexts($cached_values);
    $edit = FALSE;
    if (!empty($contexts[$context_id])) {
      $context = $contexts[$context_id];
      $machine_name = $context_id;
      $edit = TRUE;
    }
    else {
      if (strpos($context_id, 'entity:') === 0) {
        $context_definition = new EntityContextDefinition($context_id);
      }
      else {
        $context_definition = new ContextDefinition($context_id);
      }
      $context = new Context($context_definition);
      $machine_name = '';
    }
    $label = $context
      ->getContextDefinition()
      ->getLabel();
    $description = $context
      ->getContextDefinition()
      ->getDescription();
    $data_type = $context
      ->getContextDefinition()
      ->getDataType();
    $form['#attached']['library'][] = 'core/drupal.dialog.ajax';
    $form['context_id'] = [
      '#type' => 'value',
      '#value' => $context_id,
    ];
    $form['label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Label'),
      '#default_value' => $label,
      '#required' => TRUE,
    ];
    $form['machine_name'] = [
      '#type' => 'machine_name',
      '#title' => $this
        ->t('Machine Name'),
      '#default_value' => $machine_name,
      '#required' => TRUE,
      '#maxlength' => 128,
      '#machine_name' => [
        'source' => [
          'label',
        ],
        'exists' => [
          $this,
          'contextExists',
        ],
      ],
      '#disabled' => $this
        ->disableMachineName($cached_values, $machine_name),
    ];
    $form['description'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Description'),
      '#default_value' => $description,
    ];
    if (strpos($data_type, 'entity:') === 0) {
      list(, $entity_type) = explode(':', $data_type);

      /** @var \Drupal\Core\Entity\Plugin\DataType\EntityAdapter $entity */
      $entity = $edit ? $context
        ->getContextValue() : NULL;
      $form['context_value'] = [
        '#type' => 'entity_autocomplete',
        '#required' => TRUE,
        '#target_type' => $entity_type,
        '#default_value' => $entity,
        '#title' => $this
          ->t('Select entity'),
      ];
    }
    else {
      $value = $context
        ->getContextData()
        ->getValue();
      $form['context_value'] = [
        '#title' => $this
          ->t('Set a context value'),
        '#type' => 'textfield',
        '#required' => TRUE,
        '#default_value' => $value,
      ];
    }
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#ajax' => [
        'callback' => [
          $this,
          'ajaxSave',
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    // If these are not equal, then we're adding a new context and should not override an existing context.
    if ($form_state
      ->getValue('machine_name') != $form_state
      ->getValue('context_id')) {
      $machine_name = $form_state
        ->getValue('machine_name');
      $cached_values = $this->tempstore
        ->get($this->tempstore_id)
        ->get($this->machine_name);
      if (!empty($this
        ->getContexts($cached_values)[$machine_name])) {
        $form_state
          ->setError($form['machine_name'], $this
          ->t('That machine name is in use by another context definition.'));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $cached_values = $this->tempstore
      ->get($this->tempstore_id)
      ->get($this->machine_name);
    $contexts = $this
      ->getContexts($cached_values);
    if ($form_state
      ->getValue('machine_name') != $form_state
      ->getValue('context_id')) {
      $data_type = $form_state
        ->getValue('context_id');
      if (strpos($data_type, 'entity:') === 0) {
        $context_definition = new EntityContextDefinition($data_type, $form_state
          ->getValue('label'), TRUE, FALSE, $form_state
          ->getValue('description'));
      }
      else {
        $context_definition = new ContextDefinition($data_type, $form_state
          ->getValue('label'), TRUE, FALSE, $form_state
          ->getValue('description'));
      }
    }
    else {
      $context = $contexts[$form_state
        ->getValue('machine_name')];
      $context_definition = $context
        ->getContextDefinition();
      $context_definition
        ->setLabel($form_state
        ->getValue('label'));
      $context_definition
        ->setDescription($form_state
        ->getValue('description'));
    }

    // We're dealing with an entity and should make sure it's loaded.
    if (strpos($context_definition
      ->getDataType(), 'entity:') === 0) {
      list(, $entity_type) = explode(':', $context_definition
        ->getDataType());
      if (is_numeric($form_state
        ->getValue('context_value'))) {
        $value = $this->entityTypeManager
          ->getStorage($entity_type)
          ->load($form_state
          ->getValue('context_value'));
      }
    }
    else {
      $value = $form_state
        ->getValue('context_value');
    }
    $context = new Context($context_definition, $value);
    $cached_values = $this
      ->addContext($cached_values, $form_state
      ->getValue('machine_name'), $context);
    $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 = new Url($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 contexts array from cached_values.
   *
   * @param $cached_values
   *
   * @return \Drupal\Core\Plugin\Context\ContextInterface[]
   */
  protected abstract function getContexts($cached_values);

  /**
   * Custom logic for adding a context to the cached_values contexts array.
   *
   * @param array $cached_values
   *   The cached_values currently in use.
   * @param string $context_id
   *   The context identifier.
   * @param \Drupal\Core\Plugin\Context\ContextInterface $context
   *   The context to add or update within the cached values.
   *
   * @return mixed
   *   Return the $cached_values
   */
  protected abstract function addContext($cached_values, $context_id, ContextInterface $context);

  /**
   * Custom "exists" logic for the context to be created.
   *
   * @param string $value
   *   The name of the context.
   * @param $element
   *   The machine_name element
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   *
   * @return bool
   *   Return true if a context of this name exists.
   */
  public abstract function contextExists($value, $element, $form_state);

  /**
   * Determines if the machine_name should be disabled.
   *
   * @param $cached_values
   *
   * @return bool
   */
  protected abstract function disableMachineName($cached_values, $machine_name);

}

Members

Namesort descending Modifiers Type Description Overrides
ContextConfigure::$entityTypeManager protected property Object EntityTypeManager.
ContextConfigure::$machine_name protected property
ContextConfigure::$tempstore protected property
ContextConfigure::$tempstore_id protected property
ContextConfigure::addContext abstract protected function Custom logic for adding a context to the cached_values contexts array.
ContextConfigure::ajaxSave public function
ContextConfigure::buildForm public function Form constructor. Overrides FormInterface::buildForm
ContextConfigure::contextExists abstract public function Custom "exists" logic for the context to be created.
ContextConfigure::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ContextConfigure::disableMachineName abstract protected function Determines if the machine_name should be disabled.
ContextConfigure::getContexts abstract protected function Custom logic for retrieving the contexts array from cached_values.
ContextConfigure::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ContextConfigure::getParentRouteInfo abstract protected function Document the route name and parameters for redirect after submission.
ContextConfigure::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ContextConfigure::validateForm public function Form validation handler. Overrides FormBase::validateForm
ContextConfigure::__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.
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.