Subversion Repositories php-qbpwcf

Rev

Rev 3 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
3 liveuser 1
<?php
2
 
3
namespace Guzzle\Parser\Cookie;
4
 
5
/**
6
 * Cookie parser interface
7
 */
8
interface CookieParserInterface
9
{
10
    /**
11
     * Parse a cookie string as set in a Set-Cookie HTTP header and return an associative array of data.
12
     *
13
     * @param string $cookie Cookie header value to parse
14
     * @param string $host   Host of an associated request
15
     * @param string $path   Path of an associated request
16
     * @param bool   $decode Set to TRUE to urldecode cookie values
17
     *
18
     * @return array|bool Returns FALSE on failure or returns an array of arrays, with each of the sub arrays including:
19
     *     - domain  (string) - Domain of the cookie
20
     *     - path    (string) - Path of the cookie
21
     *     - cookies (array)  - Associative array of cookie names and values
22
     *     - max_age (int)    - Lifetime of the cookie in seconds
23
     *     - version (int)    - Version of the cookie specification. RFC 2965 is 1
24
     *     - secure  (bool)   - Whether or not this is a secure cookie
25
     *     - discard (bool)   - Whether or not this is a discardable cookie
26
     *     - custom (string)  - Custom cookie data array
27
     *     - comment (string) - How the cookie is intended to be used
28
     *     - comment_url (str)- URL that contains info on how it will be used
29
     *     - port (array|str) - Array of ports or null
30
     *     - http_only (bool) - HTTP only cookie
31
     */
32
    public function parseCookie($cookie, $host = null, $path = null, $decode = false);
33
}