Http\Message\CookieJar Class Reference

Inheritance diagram for Http\Message\CookieJar:

Public Member Functions
	__construct ()
	addCookie (Cookie $cookie)
	addCookies (array $cookies)
	clear ()
	count ()
	getCookies ()
	getIterator ()
	getMatchingCookies (Cookie $cookie)
	hasCookie (Cookie $cookie)
	hasCookies ()
	removeCookie (Cookie $cookie)
	removeCookies (array $cookies)
	removeMatchingCookies ($name=null, $domain=null, $path=null)
	setCookies (array $cookies)

Protected Member Functions
	findMatchingCookies (callable $match)

Protected Attributes
	$cookies

Detailed Description

Cookie Jar holds a set of Cookies.

Author

Márk Sági-Kazár mark..nosp@m.sagi.nosp@m.kazar.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Definition at line 10 of file php-http/message/src/CookieJar.php.

Constructor & Destructor Documentation

__construct()

Http\Message\CookieJar::__construct

(

)

Definition at line 20 of file php-http/message/src/CookieJar.php.

Member Function Documentation

addCookie()

Http\Message\CookieJar::addCookie

(

Cookie

$cookie

)

Adds a cookie.

Parameters

Cookie

$cookie

Definition at line 42 of file php-http/message/src/CookieJar.php.

References Http\Message\CookieJar\$cookies, Http\Message\CookieJar\getMatchingCookies(), Http\Message\Cookie\getMaxAge(), Http\Message\Cookie\getValue(), Http\Message\CookieJar\hasCookie(), Http\Message\Cookie\hasValue(), and Http\Message\CookieJar\removeCookie().

Referenced by Http\Message\CookieJar\addCookies().

addCookies()

Http\Message\CookieJar::addCookies

(

array

$cookies

)

Adds some cookies.

Parameters

Cookie[]

$cookies

Definition at line 147 of file php-http/message/src/CookieJar.php.

References Http\Message\CookieJar\$cookies, and Http\Message\CookieJar\addCookie().

Referenced by Http\Message\CookieJar\setCookies().

clear()

Http\Message\CookieJar::clear

(

)

Removes all cookies.

Definition at line 203 of file php-http/message/src/CookieJar.php.

Referenced by Http\Message\CookieJar\setCookies().

count()

Http\Message\CookieJar::count

(

)

{}

Definition at line 211 of file php-http/message/src/CookieJar.php.

findMatchingCookies()

Http\Message\CookieJar::findMatchingCookies ( callable  $match )

protected

Finds matching cookies based on a callable.

Parameters

callable

$match

Returns

Cookie[]

Definition at line 108 of file php-http/message/src/CookieJar.php.

References Http\Message\CookieJar\$cookies.

Referenced by Http\Message\CookieJar\getCookies(), Http\Message\CookieJar\getMatchingCookies(), and Http\Message\CookieJar\removeMatchingCookies().

getCookies()

Http\Message\CookieJar::getCookies

(

)

Returns the cookies.

Returns

Cookie[]

Definition at line 76 of file php-http/message/src/CookieJar.php.

References Http\Message\CookieJar\findMatchingCookies().

getIterator()

Http\Message\CookieJar::getIterator

(

)

{}

Definition at line 219 of file php-http/message/src/CookieJar.php.

References Http\Message\CookieJar\$cookies.

getMatchingCookies()

Http\Message\CookieJar::getMatchingCookies

(

Cookie

$cookie

)

Returns all matching cookies.

Parameters

Cookie

$cookie

Returns

Cookie[]

Definition at line 92 of file php-http/message/src/CookieJar.php.

References Http\Message\CookieJar\findMatchingCookies().

Referenced by Http\Message\CookieJar\addCookie().

hasCookie()

Http\Message\CookieJar::hasCookie

(

Cookie

$cookie

)

Checks if there is a cookie.

Parameters

Cookie

$cookie

Returns

bool

Definition at line 32 of file php-http/message/src/CookieJar.php.

Referenced by Http\Message\CookieJar\addCookie().

hasCookies()

Http\Message\CookieJar::hasCookies

(

)

Checks if there are cookies.

Returns

bool

Definition at line 126 of file php-http/message/src/CookieJar.php.

removeCookie()

Http\Message\CookieJar::removeCookie

(

Cookie

$cookie

)

Removes a cookie.

Parameters

Cookie

$cookie

Definition at line 66 of file php-http/message/src/CookieJar.php.

Referenced by Http\Message\CookieJar\addCookie(), and Http\Message\CookieJar\removeCookies().

removeCookies()

Http\Message\CookieJar::removeCookies

(

array

$cookies

)

Removes some cookies.

Parameters

Cookie[]

$cookies

Definition at line 159 of file php-http/message/src/CookieJar.php.

References Http\Message\CookieJar\$cookies, and Http\Message\CookieJar\removeCookie().

Referenced by Http\Message\CookieJar\removeMatchingCookies().

removeMatchingCookies()

Http\Message\CookieJar::removeMatchingCookies	(		$name = null,
			$domain = null,
			$path = null
	)

Removes cookies which match the given parameters.

Null means that parameter should not be matched

Parameters

string | null	$name
string | null	$domain
string | null	$path

Definition at line 175 of file php-http/message/src/CookieJar.php.

References Http\Message\CookieJar\$cookies, Http\Message\CookieJar\findMatchingCookies(), and Http\Message\CookieJar\removeCookies().

setCookies()

Http\Message\CookieJar::setCookies

(

array

$cookies

)

Sets the cookies and removes any previous one.

Parameters

Cookie[]

$cookies

Definition at line 136 of file php-http/message/src/CookieJar.php.

References Http\Message\CookieJar\addCookies(), and Http\Message\CookieJar\clear().

Field Documentation

$cookies

SplObjectStorage Http\Message\CookieJar::$cookies

protected

Definition at line 18 of file php-http/message/src/CookieJar.php.

Referenced by Http\Message\CookieJar\addCookie(), Http\Message\CookieJar\addCookies(), Http\Message\CookieJar\findMatchingCookies(), Http\Message\CookieJar\getIterator(), Http\Message\CookieJar\removeCookies(), and Http\Message\CookieJar\removeMatchingCookies().

---

The documentation for this class was generated from the following file:

• php-http/message/src/CookieJar.php