SessionCookieJar.php in Zircon Profile 8.0

Namespace

GuzzleHttp\Cookie

File

vendor/guzzlehttp/guzzle/src/Cookie/SessionCookieJar.php

<?php

namespace GuzzleHttp\Cookie;


/**
 * Persists cookies in the client session
 */
class SessionCookieJar extends CookieJar {

  /** @var string session key */
  private $sessionKey;

  /** @var bool Control whether to presist session cookies or not. */
  private $storeSessionCookies;

  /**
   * Create a new SessionCookieJar object
   *
   * @param string $sessionKey        Session key name to store the cookie
   *                                  data in session
   * @param bool $storeSessionCookies Set to true to store session cookies
   *                                  in the cookie jar.
   */
  public function __construct($sessionKey, $storeSessionCookies = false) {
    $this->sessionKey = $sessionKey;
    $this->storeSessionCookies = $storeSessionCookies;
    $this
      ->load();
  }

  /**
   * Saves cookies to session when shutting down
   */
  public function __destruct() {
    $this
      ->save();
  }

  /**
   * Save cookies to the client session
   */
  public function save() {
    $json = [];
    foreach ($this as $cookie) {

      /** @var SetCookie $cookie */
      if (CookieJar::shouldPersist($cookie, $this->storeSessionCookies)) {
        $json[] = $cookie
          ->toArray();
      }
    }
    $_SESSION[$this->sessionKey] = json_encode($json);
  }

  /**
   * Load the contents of the client session into the data array
   */
  protected function load() {
    $cookieJar = isset($_SESSION[$this->sessionKey]) ? $_SESSION[$this->sessionKey] : null;
    $data = json_decode($cookieJar, true);
    if (is_array($data)) {
      foreach ($data as $cookie) {
        $this
          ->setCookie(new SetCookie($cookie));
      }
    }
    elseif (strlen($data)) {
      throw new \RuntimeException("Invalid cookie data");
    }
  }

}

Classes

Name	Description
SessionCookieJar	Persists cookies in the client session