class TempStore in AJAX Comments 8

A service to help store and retrieve data to be used across HTTP requests.

@package Drupal\ajax_comments

Hierarchy

• class \Drupal\ajax_comments\TempStore

3 files declare their use of TempStore

AjaxCommentsController.php in src/Controller/AjaxCommentsController.php

AjaxCommentsDeleteForm.php in src/Form/AjaxCommentsDeleteForm.php

AjaxCommentsForm.php in src/Form/AjaxCommentsForm.php

1 string reference to 'TempStore'

ajax_comments.services.yml in ./ajax_comments.services.yml

ajax_comments.services.yml

1 service uses TempStore

ajax_comments.temp_store in ./ajax_comments.services.yml

Drupal\ajax_comments\TempStore

File

src/TempStore.php, line 17

Namespace

Drupal\ajax_comments

class TempStore {

  /**
   * The PrivateTempStore service.
   *
   * This service stores temporary data to be used across HTTP requests.
   *
   * @var \Drupal\user\PrivateTempStore
   */
  protected $privateTempStore;

  /**
   * TempStore constructor.
   *
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $private_temp_store_factory
   *   The factory to create the PrivateTempStore object.
   */
  public function __construct(PrivateTempStoreFactory $private_temp_store_factory) {
    $this->privateTempStore = $private_temp_store_factory
      ->get('ajax_comments');
  }

  /**
   * Store a newly-added comment ID for retrieval across HTTP requests.
   *
   * @param mixed $cid
   *   The comment ID to store for the newly-added comment.
   */
  public function setCid($cid) {
    $this->privateTempStore
      ->set('cid', $cid);
  }

  /**
   * Retrieve a newly-added comment ID set in a previous request by setCid().
   *
   * @return mixed
   *   The comment ID saved in ::setCid().
   */
  public function getCid() {
    return $this->privateTempStore
      ->get('cid');
  }

  /**
   * Get a single selector value, without the '#' prefix.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   * @param string $selector
   *   The selector to retrieve.
   *
   * @return string
   *   The value of the selector.
   */
  public function getSelectorValue(Request $request, $selector) {
    $selectors = $this
      ->getSelectors($request);
    $value = $selectors[$selector];
    return substr($value, strpos($value, '#') + 1);
  }

  /**
   * Retrieve the selectors included in the form submission HTTP request.
   *
   * Store the selectors in the privateTempStore so that they are available
   * for a subsequent HTTP response (when the #lazy_builder callback runs).
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   * @param bool $overwrite
   *   Boolean to indicate if an existing selector should be overwritten if
   *   a different value exists in the request.
   *
   * @return array
   *   An array of the selectors, keyed by selector name.
   */
  public function getSelectors(Request $request, $overwrite = FALSE) {
    $selectors = [
      'wrapper_html_id' => NULL,
      'form_html_id' => NULL,
    ];
    foreach ($selectors as $selector_name => $selector) {
      $request_value = $request->request
        ->get($selector_name);
      $existing_value = $this->privateTempStore
        ->get($selector_name);
      if (!empty($request_value) && ($overwrite || empty($existing_value))) {
        $value = '#' . $request_value;
        $this->privateTempStore
          ->set($selector_name, $value);
        $selectors[$selector_name] = $value;
      }
      else {
        $selectors[$selector_name] = $existing_value;
      }
    }
    return $selectors;
  }

  /**
   * Set the selector for an ajax element for use across HTTP requests.
   *
   * @param string $selector
   *   The selector to update.
   * @param string $value
   *   The new value for the selector.
   *
   * @throws \Drupal\user\TempStoreException
   */
  public function setSelector($selector, $value) {
    $this->privateTempStore
      ->set($selector, '#' . $value);
  }

  /**
   * Update the temp store values while rebuilding a form, when necessary.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   * @param array $form
   *   A form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   * @param bool $is_validating
   *   Indicates if this method has been called from a form validation function.
   *
   * @throws \Drupal\user\TempStoreException
   */
  public function processForm(Request $request, $form, FormStateInterface $form_state, $is_validating = FALSE) {
    $form_machine_name = $this->privateTempStore
      ->get('form_machine_name');
    $form_build_info = $form_state
      ->getBuildInfo();

    // If this form is being built through ajax, update the stored value
    // of form_html_id.
    if (Utility::isAjaxRequest($request)) {
      if ($is_validating) {
        $this
          ->setSelector('form_html_id', $form['form_html_id']['#value']);
        $this->privateTempStore
          ->set('form_machine_name', $form_build_info['form_id']);
      }
      elseif ($form_build_info['form_id'] === $form_machine_name) {
        $this
          ->setSelector('form_html_id', $form['form_html_id']['#value']);
      }
    }
  }

  /**
   * Delete the values from the privateTempStore.
   *
   * @throws \Drupal\user\TempStoreException
   */
  public function deleteAll() {
    $values = [
      'wrapper_html_id',
      'form_html_id',
      'form_machine_name',
      'cid',
    ];
    foreach ($values as $value) {
      $this->privateTempStore
        ->delete($value);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
TempStore::$privateTempStore	protected	property	The PrivateTempStore service.
TempStore::deleteAll	public	function	Delete the values from the privateTempStore.
TempStore::getCid	public	function	Retrieve a newly-added comment ID set in a previous request by setCid().
TempStore::getSelectors	public	function	Retrieve the selectors included in the form submission HTTP request.
TempStore::getSelectorValue	public	function	Get a single selector value, without the '#' prefix.
TempStore::processForm	public	function	Update the temp store values while rebuilding a form, when necessary.
TempStore::setCid	public	function	Store a newly-added comment ID for retrieval across HTTP requests.
TempStore::setSelector	public	function	Set the selector for an ajax element for use across HTTP requests.
TempStore::__construct	public	function	TempStore constructor.