84 lines
1.8 KiB
PHP
84 lines
1.8 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
namespace Guzzle\Http\Message\Header;
|
||
|
|
|
||
|
|
use Guzzle\Common\ToArrayInterface;
|
||
|
|
|
||
|
|
interface HeaderInterface extends ToArrayInterface, \Countable, \IteratorAggregate
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* Convert the header to a string
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function __toString();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Add a value to the list of header values
|
||
|
|
*
|
||
|
|
* @param string $value Value to add to the header
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function add($value);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the name of the header
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getName();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Change the name of the header
|
||
|
|
*
|
||
|
|
* @param string $name Name to change to
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function setName($name);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Change the glue used to implode the values
|
||
|
|
*
|
||
|
|
* @param string $glue Glue used to implode multiple values
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function setGlue($glue);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the glue used to implode multiple values into a string
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getGlue();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check if the collection of headers has a particular value
|
||
|
|
*
|
||
|
|
* @param string $searchValue Value to search for
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function hasValue($searchValue);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Remove a specific value from the header
|
||
|
|
*
|
||
|
|
* @param string $searchValue Value to remove
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function removeValue($searchValue);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Parse a header containing ";" separated data into an array of associative arrays representing the header
|
||
|
|
* key value pair data of the header. When a parameter does not contain a value, but just contains a key, this
|
||
|
|
* function will inject a key with a '' string value.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function parseParams();
|
||
|
|
}
|