Dflydev\FigCookies\SetCookies Class Reference

Collaboration diagram for Dflydev\FigCookies\SetCookies:

Public Member Functions
	__construct (array $setCookies=[])
	has ($name)
	get ($name)
	getAll ()
	with (SetCookie $setCookie)
	without ($name)
	renderIntoSetCookieHeader (ResponseInterface $response)
	Render SetCookies into a Response. More...

Static Public Member Functions
static	fromSetCookieStrings ($setCookieStrings)
	Create SetCookies from a collection of SetCookie header value strings. More...
static	fromResponse (ResponseInterface $response)
	Create SetCookies from a Response. More...

Data Fields
const	SET_COOKIE_HEADER = 'Set-Cookie'
	The name of the Set-Cookie header. More...

Private Attributes
	$setCookies = []

Detailed Description

Definition at line 7 of file SetCookies.php.

Constructor & Destructor Documentation

__construct()

Dflydev\FigCookies\SetCookies::__construct

(

array

$setCookies = []

)

Parameters

SetCookie[]

$setCookies

Definition at line 22 of file SetCookies.php.

References Dflydev\FigCookies\SetCookies\$setCookies.

    {
        foreach ($setCookies as $setCookie) {
            $this->setCookies[$setCookie->getName()] = $setCookie;
        }
    }

Member Function Documentation

fromResponse()

static Dflydev\FigCookies\SetCookies::fromResponse ( ResponseInterface  $response )

static

Create SetCookies from a Response.

Parameters

ResponseInterface

$response

Returns

SetCookies

Definition at line 124 of file SetCookies.php.

References Psr\Http\Message\MessageInterface\getHeader().

Referenced by ILIAS\HTTP\Cookies\CookieJarFactoryImpl\fromResponse(), Dflydev\FigCookies\FigResponseCookies\get(), Dflydev\FigCookies\SetCookiesTest\it_creates_from_response(), Dflydev\FigCookies\SetCookiesTest\it_gets_and_updates_set_cookie_value_on_request(), Dflydev\FigCookies\FigResponseCookies\modify(), Dflydev\FigCookies\FigResponseCookies\remove(), and Dflydev\FigCookies\FigResponseCookies\set().

    {
        return new static(array_map(function ($setCookieString) {
            return SetCookie::fromSetCookieString($setCookieString);
        }, $response->getHeader(static::SET_COOKIE_HEADER)));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fromSetCookieStrings()

static Dflydev\FigCookies\SetCookies::fromSetCookieStrings (   $setCookieStrings )

static

Create SetCookies from a collection of SetCookie header value strings.

Parameters

string[]

$setCookieStrings

Returns

static

Definition at line 111 of file SetCookies.php.

Referenced by ILIAS\HTTP\Cookies\CookieJarFactoryImpl\fromCookieStrings(), Dflydev\FigCookies\SetCookiesTest\it_creates_from_set_cookie_strings(), Dflydev\FigCookies\SetCookiesTest\it_gets_set_cookie_by_name(), Dflydev\FigCookies\SetCookiesTest\it_knows_which_set_cookies_are_available(), and Dflydev\FigCookies\SetCookiesTest\it_renders_added_and_removed_set_cookies_header().

    {
        return new static(array_map(function ($setCookieString) {
            return SetCookie::fromSetCookieString($setCookieString);
        }, $setCookieStrings));
    }

Here is the caller graph for this function:

get()

Dflydev\FigCookies\SetCookies::get

(

$name

)

Parameters

string

$name

Returns

SetCookie|null

Definition at line 42 of file SetCookies.php.

References $name, and Dflydev\FigCookies\SetCookies\has().

    {
        if (! $this->has($name)) {
            return null;
        }

        return $this->setCookies[$name];
    }

Here is the call graph for this function:

getAll()

Dflydev\FigCookies\SetCookies::getAll

(

)

Returns

SetCookie[]

Definition at line 54 of file SetCookies.php.

    {
        return array_values($this->setCookies);
    }

has()

Dflydev\FigCookies\SetCookies::has

(

$name

)

Parameters

string

$name

Returns

bool

Definition at line 33 of file SetCookies.php.

References $name.

Referenced by Dflydev\FigCookies\SetCookies\get().

    {
        return isset($this->setCookies[$name]);
    }

Here is the caller graph for this function:

renderIntoSetCookieHeader()

Dflydev\FigCookies\SetCookies::renderIntoSetCookieHeader

(

ResponseInterface

$response

)

Render SetCookies into a Response.

Parameters

ResponseInterface

$response

Returns

ResponseInterface

Definition at line 95 of file SetCookies.php.

References $response, Psr\Http\Message\MessageInterface\withAddedHeader(), and Psr\Http\Message\MessageInterface\withoutHeader().

    {
        $response = $response->withoutHeader(static::SET_COOKIE_HEADER);
        foreach ($this->setCookies as $setCookie) {
            $response = $response->withAddedHeader(static::SET_COOKIE_HEADER, (string) $setCookie);
        }

        return $response;
    }

Here is the call graph for this function:

with()

Dflydev\FigCookies\SetCookies::with

(

SetCookie

$setCookie

)

Parameters

SetCookie

$setCookie

Returns

SetCookies

Definition at line 63 of file SetCookies.php.

References Dflydev\FigCookies\SetCookie\getName().

    {
        $clone = clone($this);

        $clone->setCookies[$setCookie->getName()] = $setCookie;

        return $clone;
    }

Here is the call graph for this function:

without()

Dflydev\FigCookies\SetCookies::without

(

$name

)

Parameters

string

$name

Returns

SetCookies

Definition at line 76 of file SetCookies.php.

References $name.

    {
        $clone = clone($this);

        if (! $clone->has($name)) {
            return $clone;
        }

        unset($clone->setCookies[$name]);

        return $clone;
    }

Field Documentation

$setCookies

Dflydev\FigCookies\SetCookies::$setCookies = []

private

Definition at line 17 of file SetCookies.php.

Referenced by Dflydev\FigCookies\SetCookies\__construct().

SET_COOKIE_HEADER

const Dflydev\FigCookies\SetCookies::SET_COOKIE_HEADER = 'Set-Cookie'

The name of the Set-Cookie header.

Definition at line 12 of file SetCookies.php.

Referenced by Dflydev\FigCookies\SetCookiesTest\it_creates_from_response(), Dflydev\FigCookies\FigCookiesTest\it_encrypts_and_decrypts_cookies(), Dflydev\FigCookies\SetCookiesTest\it_gets_and_updates_set_cookie_value_on_request(), Dflydev\FigCookies\FigResponseCookiesTest\it_gets_cookies(), Dflydev\FigCookies\FigResponseCookiesTest\it_modifies_cookies(), Dflydev\FigCookies\FigResponseCookiesTest\it_removes_cookies(), Dflydev\FigCookies\SetCookiesTest\it_renders_added_and_removed_set_cookies_header(), and Dflydev\FigCookies\FigResponseCookiesTest\it_sets_cookies().

---

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

• libs/composer/vendor/dflydev/fig-cookies/src/Dflydev/FigCookies/SetCookies.php