File src/Guzzle/Plugin/Cookie/CookiePlugin.php | Omnipay Viva Payments Gateway Module API Documentation

Namespaces

Guzzle
- Batch
  - Exception
- Cache
- Common
  - Exception
- Http
  - Curl
  - Exception
  - Message
    - Header
  - QueryAggregator
- Inflection
- Iterator
- Log
- Parser
  - Cookie
  - Message
  - UriTemplate
  - Url
- Plugin
  - Async
  - Backoff
  - Cache
  - Cookie
    - CookieJar
    - Exception
  - CurlAuth
  - ErrorResponse
    - Exception
  - History
  - Log
  - Md5
  - Mock
  - Oauth
- Service
  - Builder
  - Command
    - Factory
    - LocationVisitor
      - Request
      - Response
  - Description
  - Exception
  - Resource
- Stream
- Tests
  - Batch
  - Cache
  - Common
    - Cache
    - Exception
  - Http
    - Curl
    - Exception
    - Message
      - Header
  - Inflection
  - Iterator
  - Log
  - Message
  - Mock
  - Parser
    - Cookie
    - Message
  - Parsers
    - UriTemplate
  - Plugin
    - Async
    - Backoff
    - Cache
    - Cookie
      - CookieJar
    - CurlAuth
    - ErrorResponse
    - History
    - Log
    - Md5
    - Mock
    - Oauth
    - Redirect
  - Service
    - Builder
    - Command
      - LocationVisitor
        
        Request
        
        Response
    - Description
    - Exception
    - Mock
      - Command
        
        Sub
      - Model
    - Resource
  - Stream
None
Omnipay
- Common
  - Exception
  - Message
- Dummy
  - Message
- VivaPayments
  - Message
PHP

Classes

Interfaces

Exceptions

 1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71:

<?php

namespace Guzzle\Plugin\Cookie;

use Guzzle\Common\Event;
use Guzzle\Plugin\Cookie\CookieJar\ArrayCookieJar;
use Guzzle\Plugin\Cookie\CookieJar\CookieJarInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * Adds, extracts, and persists cookies between HTTP requests
 */
class CookiePlugin implements EventSubscriberInterface
{
    /** @var CookieJarInterface Cookie cookieJar used to hold cookies */
    protected $cookieJar;

    /**
     * @param CookieJarInterface $cookieJar Cookie jar used to hold cookies. Creates an ArrayCookieJar by default.
     */
    public function __construct(CookieJarInterface $cookieJar = null)
    {
        $this->cookieJar = $cookieJar ?: new ArrayCookieJar();
    }

    public static function getSubscribedEvents()
    {
        return array(
            'request.before_send' => array('onRequestBeforeSend', 125),
            'request.sent'        => array('onRequestSent', 125)
        );
    }

    /**
     * Get the cookie cookieJar
     *
     * @return CookieJarInterface
     */
    public function getCookieJar()
    {
        return $this->cookieJar;
    }

    /**
     * Add cookies before a request is sent
     *
     * @param Event $event
     */
    public function onRequestBeforeSend(Event $event)
    {
        $request = $event['request'];
        if (!$request->getParams()->get('cookies.disable')) {
            $request->removeHeader('Cookie');
            // Find cookies that match this request
            foreach ($this->cookieJar->getMatchingCookies($request) as $cookie) {
                $request->addCookie($cookie->getName(), $cookie->getValue());
            }
        }
    }

    /**
     * Extract cookies from a sent request
     *
     * @param Event $event
     */
    public function onRequestSent(Event $event)
    {
        $this->cookieJar->addCookiesFromResponse($event['response'], $event['request']);
    }
}