Dflydev\FigCookies\FigRequestCookies Class Reference

Collaboration diagram for Dflydev\FigCookies\FigRequestCookies:

Static Public Member Functions
static	get (RequestInterface $request, $name, $value=null)
static	set (RequestInterface $request, Cookie $cookie)
static	modify (RequestInterface $request, $name, $modify)
static	remove (RequestInterface $request, $name)

Detailed Description

Definition at line 8 of file FigRequestCookies.php.

Member Function Documentation

get()

static Dflydev\FigCookies\FigRequestCookies::get ( RequestInterface  $request,   $name,   $value = null  )

static

Parameters

RequestInterface	$request
string	$name
string | null	$value

Returns

Cookie

Definition at line 17 of file FigRequestCookies.php.

References Dflydev\FigCookies\Cookie\create(), and Dflydev\FigCookies\Cookies\fromRequest().

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

    {
        $cookies = Cookies::fromRequest($request);
        if ($cookies->has($name)) {
            return $cookies->get($name);
        }

        return Cookie::create($name, $value);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

modify()

static Dflydev\FigCookies\FigRequestCookies::modify ( RequestInterface  $request,   $name,   $modify  )

static

Parameters

RequestInterface	$request
string	$name
callable	$modify

Returns

RequestInterface

Definition at line 48 of file FigRequestCookies.php.

References Dflydev\FigCookies\Cookie\create(), and Dflydev\FigCookies\Cookies\fromRequest().

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

    {
        if (! is_callable($modify)) {
            throw new InvalidArgumentException('$modify must be callable.');
        }

        $cookies = Cookies::fromRequest($request);
        $cookie = $modify($cookies->has($name)
            ? $cookies->get($name)
            : Cookie::create($name)
        );

        return $cookies
            ->with($cookie)
            ->renderIntoCookieHeader($request)
        ;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

remove()

static Dflydev\FigCookies\FigRequestCookies::remove ( RequestInterface  $request,   $name  )

static

Parameters

RequestInterface	$request
string	$name

Returns

RequestInterface

Definition at line 72 of file FigRequestCookies.php.

References Dflydev\FigCookies\Cookies\fromRequest().

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

    {
        return Cookies::fromRequest($request)
            ->without($name)
            ->renderIntoCookieHeader($request)
        ;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

set()

static Dflydev\FigCookies\FigRequestCookies::set ( RequestInterface  $request, Cookie  $cookie  )

static

Parameters

RequestInterface	$request
Cookie	$cookie

Returns

RequestInterface

Definition at line 33 of file FigRequestCookies.php.

References Dflydev\FigCookies\Cookies\fromRequest().

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

    {
        return Cookies::fromRequest($request)
            ->with($cookie)
            ->renderIntoCookieHeader($request)
        ;
    }

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/FigRequestCookies.php