File src/Guzzle/Plugin/Cookie/CookieJar/FileCookieJar.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:

<?php

namespace Guzzle\Plugin\Cookie\CookieJar;

use Guzzle\Common\Exception\RuntimeException;

/**
 * Persists non-session cookies using a JSON formatted file
 */
class FileCookieJar extends ArrayCookieJar
{
    /** @var string filename */
    protected $filename;

    /**
     * Create a new FileCookieJar object
     *
     * @param string $cookieFile File to store the cookie data
     *
     * @throws RuntimeException if the file cannot be found or created
     */
    public function __construct($cookieFile)
    {
        $this->filename = $cookieFile;
        $this->load();
    }

    /**
     * Saves the file when shutting down
     */
    public function __destruct()
    {
        $this->persist();
    }

    /**
     * Save the contents of the data array to the file
     *
     * @throws RuntimeException if the file cannot be found or created
     */
    protected function persist()
    {
        if (false === file_put_contents($this->filename, $this->serialize())) {
            // @codeCoverageIgnoreStart
            throw new RuntimeException('Unable to open file ' . $this->filename);
            // @codeCoverageIgnoreEnd
        }
    }

    /**
     * Load the contents of the json formatted file into the data array and discard any unsaved state
     */
    protected function load()
    {
        $json = file_get_contents($this->filename);
        if (false === $json) {
            // @codeCoverageIgnoreStart
            throw new RuntimeException('Unable to open file ' . $this->filename);
            // @codeCoverageIgnoreEnd
        }

        $this->unserialize($json);
        $this->cookies = $this->cookies ?: array();
    }
}