Dflydev\FigCookies\Cookies Class Reference

Collaboration diagram for Dflydev\FigCookies\Cookies:

Public Member Functions
	__construct (array $cookies=[])
	has ($name)
	get ($name)
	getAll ()
	with (Cookie $cookie)
	without ($name)
	renderIntoCookieHeader (RequestInterface $request)
	Render Cookies into a Request. More...

Static Public Member Functions
static	fromCookieString ($string)
	Create Cookies from a Cookie header value string. More...
static	fromRequest (RequestInterface $request)
	Create Cookies from a Request. More...

Data Fields
const	COOKIE_HEADER = 'Cookie'
	The name of the Cookie header. More...

Private Attributes
	$cookies = []

Detailed Description

Definition at line 7 of file Cookies.php.

Constructor & Destructor Documentation

__construct()

Dflydev\FigCookies\Cookies::__construct

(

array

$cookies = []

)

Parameters

Cookie[]

$cookies

Definition at line 22 of file Cookies.php.

References Dflydev\FigCookies\Cookies\$cookies.

    {
        foreach ($cookies as $cookie) {
            $this->cookies[$cookie->getName()] = $cookie;
        }
    }

Member Function Documentation

fromCookieString()

static Dflydev\FigCookies\Cookies::fromCookieString (   $string )

static

Create Cookies from a Cookie header value string.

Parameters

$string

Returns

static

Definition at line 110 of file Cookies.php.

References Dflydev\FigCookies\Cookie\listFromCookieString().

Referenced by Dflydev\FigCookies\CookiesTest\it_creates_from_cookie_string(), Dflydev\FigCookies\CookiesTest\it_gets_cookie_by_name(), Dflydev\FigCookies\CookiesTest\it_knows_which_cookies_are_available(), and Dflydev\FigCookies\CookiesTest\it_renders_added_and_removed_cookies_header().

    {
        return new static(Cookie::listFromCookieString($string));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fromRequest()

static Dflydev\FigCookies\Cookies::fromRequest ( RequestInterface  $request )

static

Create Cookies from a Request.

Parameters

RequestInterface

$request

Returns

Cookies

Definition at line 121 of file Cookies.php.

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

Referenced by Dflydev\FigCookies\FigRequestCookies\get(), Dflydev\FigCookies\CookiesTest\it_creates_from_request(), Dflydev\FigCookies\CookiesTest\it_gets_and_updates_cookie_value_on_request(), Dflydev\FigCookies\CookiesTest\it_gets_cookie_value_from_request(), Dflydev\FigCookies\FigRequestCookies\modify(), Dflydev\FigCookies\FigRequestCookies\remove(), and Dflydev\FigCookies\FigRequestCookies\set().

    {
        $cookieString = $request->getHeaderLine(static::COOKIE_HEADER);

        return static::fromCookieString($cookieString);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

get()

Dflydev\FigCookies\Cookies::get

(

$name

)

Parameters

$name

Returns

Cookie|null

Definition at line 42 of file Cookies.php.

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

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

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

Here is the call graph for this function:

getAll()

Dflydev\FigCookies\Cookies::getAll

(

)

Returns

Cookie[]

Definition at line 54 of file Cookies.php.

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

has()

Dflydev\FigCookies\Cookies::has

(

$name

)

Parameters

$name

Returns

bool

Definition at line 33 of file Cookies.php.

References $name.

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

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

Here is the caller graph for this function:

renderIntoCookieHeader()

Dflydev\FigCookies\Cookies::renderIntoCookieHeader

(

RequestInterface

$request

)

Render Cookies into a Request.

Parameters

RequestInterface

$request

Returns

RequestInterface

Definition at line 95 of file Cookies.php.

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

    {
        $cookieString = implode('; ', $this->cookies);

        $request = $request->withHeader(static::COOKIE_HEADER, $cookieString);

        return $request;
    }

Here is the call graph for this function:

with()

Dflydev\FigCookies\Cookies::with

(

Cookie

$cookie

)

Parameters

Cookie

$cookie

Returns

Cookies

Definition at line 63 of file Cookies.php.

References Dflydev\FigCookies\Cookie\getName().

    {
        $clone = clone($this);

        $clone->cookies[$cookie->getName()] = $cookie;

        return $clone;
    }

Here is the call graph for this function:

without()

Dflydev\FigCookies\Cookies::without

(

$name

)

Parameters

$name

Returns

Cookies

Definition at line 76 of file Cookies.php.

References $name.

    {
        $clone = clone($this);

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

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

        return $clone;
    }

Field Documentation

$cookies

Dflydev\FigCookies\Cookies::$cookies = []

private

Definition at line 17 of file Cookies.php.

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

COOKIE_HEADER

const Dflydev\FigCookies\Cookies::COOKIE_HEADER = 'Cookie'

The name of the Cookie header.

Definition at line 12 of file Cookies.php.

Referenced by Dflydev\FigCookies\CookiesTest\it_creates_from_request(), Dflydev\FigCookies\FigCookiesTest\it_encrypts_and_decrypts_cookies(), Dflydev\FigCookies\CookiesTest\it_gets_and_updates_cookie_value_on_request(), Dflydev\FigCookies\CookiesTest\it_gets_cookie_value_from_request(), Dflydev\FigCookies\FigRequestCookiesTest\it_gets_cookies(), Dflydev\FigCookies\FigRequestCookiesTest\it_modifies_cookies(), Dflydev\FigCookies\FigRequestCookiesTest\it_removes_cookies(), Dflydev\FigCookies\CookiesTest\it_renders_added_and_removed_cookies_header(), Dflydev\FigCookies\CookiesTest\it_renders_new_cookies_into_empty_cookie_header(), and Dflydev\FigCookies\FigRequestCookiesTest\it_sets_cookies().

---

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

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