public function NativeSessionStorage::regenerate

Regenerates id that represents this storage.

This method must invoke session_regenerate_id($destroy) unless this interface is used for a storage object designed for unit or functional testing where a real PHP session would interfere with testing.

Note regenerate+destroy should not clear the session data in memory only delete the session data from persistent storage.

@api

Parameters

Boolean $destroy Destroy session when regenerating?:

integer $lifetime Sets the cookie lifetime for the session cookie. A null value: will leave the system settings unchanged, 0 sets the cookie to expire with browser session. Time is in seconds, and is not a Unix timestamp.

Return value

Boolean True if session regenerated, false if error

Throws

\RuntimeException If an error occurs while regenerating this storage

Overrides SessionStorageInterface::regenerate

File

drupal/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php, line 200

Class

NativeSessionStorage

This provides a base class for session attribute storage.

Namespace

Code

public function regenerate($destroy = false, $lifetime = null) {
  if (null !== $lifetime) {
    ini_set('session.cookie_lifetime', $lifetime);
  }
  if ($destroy) {
    $this->metadataBag
      ->stampNew();
  }
  return session_regenerate_id($destroy);
}