Dflydev\FigCookies\FigResponseCookies Class Reference

Collaboration diagram for Dflydev\FigCookies\FigResponseCookies:

Static Public Member Functions
static	get (ResponseInterface $response, $name, $value=null)
static	set (ResponseInterface $response, SetCookie $setCookie)
static	expire (ResponseInterface $response, $cookieName)
static	modify (ResponseInterface $response, $name, $modify)
static	remove (ResponseInterface $response, $name)

Detailed Description

Definition at line 8 of file FigResponseCookies.php.

Member Function Documentation

expire()

static Dflydev\FigCookies\FigResponseCookies::expire ( ResponseInterface  $response,   $cookieName  )

static

Parameters

ResponseInterface	$response
string	$cookieName

Returns

ResponseInterface

Definition at line 47 of file FigResponseCookies.php.

    {
        return static::set($response, SetCookie::createExpired($cookieName));
    }

References $cookieName, $response, and Dflydev\FigCookies\SetCookie\createExpired().

Here is the call graph for this function:

get()

static Dflydev\FigCookies\FigResponseCookies::get ( ResponseInterface  $response,   $name,   $value = null  )

static

Parameters

ResponseInterface	$response
string	$name
string | null	$value

Returns

SetCookie

Definition at line 17 of file FigResponseCookies.php.

    {
        $setCookies = SetCookies::fromResponse($response);
        if ($setCookies->has($name)) {
            return $setCookies->get($name);
        }
 
        return SetCookie::create($name, $value);
    }

References $name, $response, Dflydev\FigCookies\SetCookie\create(), and Dflydev\FigCookies\SetCookies\fromResponse().

Referenced by Dflydev\FigCookies\FigResponseCookiesTest\it_gets_cookies().

Here is the call graph for this function:

Here is the caller graph for this function:

modify()

static Dflydev\FigCookies\FigResponseCookies::modify ( ResponseInterface  $response,   $name,   $modify  )

static

Parameters

ResponseInterface	$response
string	$name
callable	$modify

Returns

ResponseInterface

Definition at line 59 of file FigResponseCookies.php.

    {
        if (! is_callable($modify)) {
            throw new InvalidArgumentException('$modify must be callable.');
        }
 
        $setCookies = SetCookies::fromResponse($response);
        $setCookie = $modify($setCookies->has($name)
            ? $setCookies->get($name)
            : SetCookie::create($name)
        );
 
        return $setCookies
            ->with($setCookie)
            ->renderIntoSetCookieHeader($response)
        ;
    }

References $name, $response, Dflydev\FigCookies\SetCookie\create(), and Dflydev\FigCookies\SetCookies\fromResponse().

Referenced by Dflydev\FigCookies\FigCookiesTest\it_encrypts_and_decrypts_cookies(), and Dflydev\FigCookies\FigResponseCookiesTest\it_modifies_cookies().

Here is the call graph for this function:

Here is the caller graph for this function:

remove()

static Dflydev\FigCookies\FigResponseCookies::remove ( ResponseInterface  $response,   $name  )

static

Parameters

ResponseInterface	$response
string	$name

Returns

ResponseInterface

Definition at line 83 of file FigResponseCookies.php.

    {
        return SetCookies::fromResponse($response)
            ->without($name)
            ->renderIntoSetCookieHeader($response)
        ;
    }

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

Referenced by Dflydev\FigCookies\FigResponseCookiesTest\it_removes_cookies().

Here is the call graph for this function:

Here is the caller graph for this function:

set()

static Dflydev\FigCookies\FigResponseCookies::set ( ResponseInterface  $response, SetCookie  $setCookie  )

static

Parameters

ResponseInterface	$response
SetCookie	$setCookie

Returns

ResponseInterface

Definition at line 33 of file FigResponseCookies.php.

    {
        return SetCookies::fromResponse($response)
            ->with($setCookie)
            ->renderIntoSetCookieHeader($response)
        ;
    }

References $response, and Dflydev\FigCookies\SetCookies\fromResponse().

Referenced by Dflydev\FigCookies\FigResponseCookiesTest\it_sets_cookies().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

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