PHPFUI/InstaDoc

Persists cookies in the client session

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

Create a new SessionCookieJar object

    public __destruct()
     

    Saves cookies to session when shutting down

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

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

      public GuzzleHttp\Cookie\CookieJar::getCookieByName(string $name) : GuzzleHttp\Cookie\SetCookie
       

      Finds and returns the cookie based on the name

      public GuzzleHttp\Cookie\CookieJar::getIterator() : ArrayIterator
       
      • return ArrayIterator
      public save() : void
       

      Save cookies to the client session

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

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

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

        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) : string
         

        Computes cookie path following RFC 6265 section 5.1.4

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

        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, string $domain) : self
         

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

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

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

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