FormState::setCached

public FormState::setCached($cache = TRUE)

Sets this form to be cached.

Parameters

bool $cache: TRUE if the form should be cached, FALSE otherwise.

Return value

$this

Throws

\LogicException If the current request is using an HTTP method that must not change state (e.g., GET).

Overrides FormStateInterface::setCached

File

core/lib/Drupal/Core/Form/FormState.php, line 500

Class

FormState: Stores information about the state of a form.

Namespace

Drupal\Core\Form

Code

public function setCached($cache = TRUE) {
  // Persisting $form_state is a side-effect disallowed during a "safe" HTTP
  // method.
  if ($cache && $this->isRequestMethodSafe()) {
    throw new \LogicException(sprintf('Form state caching on %s requests is not allowed.', $this->requestMethod));
  }

  $this->cache = (bool) $cache;
  return $this;
}

Links:

https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Form%21FormState.php/function/FormState%3A%3AsetCached/8.2.x

doc_Drupal

2016-10-29 09:16:03

Comments