PHPFUI/InstaDoc

Persists cookies in the client session

CloneableInstantiableIterable
ExtendsGuzzleHttp\Cookie\CookieJar
ImplementsCountable
GuzzleHttp\Cookie\CookieJarInterface
IteratorAggregate
Traversable
Methods
public __construct( $sessionKey, $storeSessionCookies = false)
 

Create a new SessionCookieJar object

    public __destruct()
     

    Saves cookies to session when shutting down

    public GuzzleHttp\Cookie\CookieJar::clear( $domain = NULL, $path = NULL, $name = NULL)
    public GuzzleHttp\Cookie\CookieJar::clearSessionCookies()
    public GuzzleHttp\Cookie\CookieJar::count()
    public GuzzleHttp\Cookie\CookieJar::extractCookies(Psr\Http\Message\RequestInterface $request, Psr\Http\Message\ResponseInterface $response)
    public static GuzzleHttp\Cookie\CookieJar::fromArray(array $cookies, $domain)
     

    Create a new Cookie jar from an associative array and domain.

    • return self
    public GuzzleHttp\Cookie\CookieJar::getCookieByName( $name)
     

    Finds and returns the cookie based on the name

    • return SetCookie|null cookie that was found or null if not found
    public static GuzzleHttp\Cookie\CookieJar::getCookieValue( $value)
     
    • deprecated
    public GuzzleHttp\Cookie\CookieJar::getIterator()
    public save()
     

    Save cookies to the client session

    public GuzzleHttp\Cookie\CookieJar::setCookie(GuzzleHttp\Cookie\SetCookie $cookie)
    public static GuzzleHttp\Cookie\CookieJar::shouldPersist(GuzzleHttp\Cookie\SetCookie $cookie, $allowSessionCookies = false)
     

    Evaluate if this cookie should be persisted to storage
    that survives between requests.

    • return bool
    public GuzzleHttp\Cookie\CookieJar::toArray()
    public GuzzleHttp\Cookie\CookieJar::withCookieHeader(Psr\Http\Message\RequestInterface $request)
    Methods
    protected load()
     

    Load the contents of the client session into the data array

    Properties
    private $sessionKey
     
    • var string session key
    private $storeSessionCookies
     
    • var bool Control whether to persist session cookies or not.
    Methods
    private GuzzleHttp\Cookie\CookieJar::getCookiePathFromRequest(Psr\Http\Message\RequestInterface $request)
     

    Computes cookie path following RFC 6265 section 5.1.4

    private GuzzleHttp\Cookie\CookieJar::removeCookieIfEmpty(GuzzleHttp\Cookie\SetCookie $cookie)
     

    If a cookie already exists and the server asks to set it again with a
    null value, the cookie must be deleted.

      Methods
      public static GuzzleHttp\Cookie\CookieJar::fromArray(array $cookies, $domain)
       

      Create a new Cookie jar from an associative array and domain.

      • return self
      public static GuzzleHttp\Cookie\CookieJar::getCookieValue( $value)
       
      • deprecated
      public static GuzzleHttp\Cookie\CookieJar::shouldPersist(GuzzleHttp\Cookie\SetCookie $cookie, $allowSessionCookies = false)
       

      Evaluate if this cookie should be persisted to storage
      that survives between requests.

      • return bool
      © 2020 Bruce Wells
      Search Namespaces \ Classes
      ConfigurationNumbers (0-9.) only