Subversion Repositories php-qbpwcf

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
3 liveuser 1
<?php
2
 
3
namespace Guzzle\Http\Message\Header;
4
 
5
use Guzzle\Common\ToArrayInterface;
6
 
7
interface HeaderInterface extends ToArrayInterface, \Countable, \IteratorAggregate
8
{
9
    /**
10
     * Convert the header to a string
11
     *
12
     * @return string
13
     */
14
    public function __toString();
15
 
16
    /**
17
     * Add a value to the list of header values
18
     *
19
     * @param string $value Value to add to the header
20
     *
21
     * @return self
22
     */
23
    public function add($value);
24
 
25
    /**
26
     * Get the name of the header
27
     *
28
     * @return string
29
     */
30
    public function getName();
31
 
32
    /**
33
     * Change the name of the header
34
     *
35
     * @param string $name Name to change to
36
     *
37
     * @return self
38
     */
39
    public function setName($name);
40
 
41
    /**
42
     * Change the glue used to implode the values
43
     *
44
     * @param string $glue Glue used to implode multiple values
45
     *
46
     * @return self
47
     */
48
    public function setGlue($glue);
49
 
50
    /**
51
     * Get the glue used to implode multiple values into a string
52
     *
53
     * @return string
54
     */
55
    public function getGlue();
56
 
57
    /**
58
     * Check if the collection of headers has a particular value
59
     *
60
     * @param string $searchValue Value to search for
61
     *
62
     * @return bool
63
     */
64
    public function hasValue($searchValue);
65
 
66
    /**
67
     * Remove a specific value from the header
68
     *
69
     * @param string $searchValue Value to remove
70
     *
71
     * @return self
72
     */
73
    public function removeValue($searchValue);
74
 
75
    /**
76
     * Parse a header containing ";" separated data into an array of associative arrays representing the header
77
     * key value pair data of the header. When a parameter does not contain a value, but just contains a key, this
78
     * function will inject a key with a '' string value.
79
     *
80
     * @return array
81
     */
82
    public function parseParams();
83
}