Dflydev\FigCookies\CookiesTest Class Reference

Inheritance diagram for Dflydev\FigCookies\CookiesTest:

Collaboration diagram for Dflydev\FigCookies\CookiesTest:

Public Member Functions
	it_creates_from_request ($cookieString, array $expectedCookies)
	it_creates_from_cookie_string ($cookieString, array $expectedCookies)
	it_knows_which_cookies_are_available ($cookieString, array $expectedCookies)
	it_gets_cookie_by_name ($cookieString, $cookieName, Cookie $expectedCookie)
	it_sets_overrides_and_removes_cookie ()
	it_renders_new_cookies_into_empty_cookie_header ()
	it_renders_added_and_removed_cookies_header ()
	it_gets_cookie_value_from_request ()
	it_gets_and_updates_cookie_value_on_request ()
	provideCookieStringAndExpectedCookiesData ()
	provideGetsCookieByNameData ()

Data Fields
const	INTERFACE_PSR_HTTP_MESSAGE_REQUEST = 'Psr\Http\Message\RequestInterface'

Detailed Description

Definition at line 5 of file CookiesTest.php.

Member Function Documentation

it_creates_from_cookie_string()

Dflydev\FigCookies\CookiesTest::it_creates_from_cookie_string	(		$cookieString,
		array	$expectedCookies
	)

Parameters

string[]	$cookieString
Cookie[]	$expectedCookies

Test:

provideCookieStringAndExpectedCookiesData

Definition at line 33 of file CookiesTest.php.

References Dflydev\FigCookies\Cookies\fromCookieString().

    {
        $cookies = Cookies::fromCookieString($cookieString);

        $this->assertEquals($expectedCookies, $cookies->getAll());
    }

Here is the call graph for this function:

it_creates_from_request()

Dflydev\FigCookies\CookiesTest::it_creates_from_request	(		$cookieString,
		array	$expectedCookies
	)

Parameters

string[]	$cookieString
Cookie[]	$expectedCookies

Test:

provideCookieStringAndExpectedCookiesData

Definition at line 16 of file CookiesTest.php.

References Dflydev\FigCookies\Cookies\COOKIE_HEADER, and Dflydev\FigCookies\Cookies\fromRequest().

    {
        $request = $this->prophesize(static::INTERFACE_PSR_HTTP_MESSAGE_REQUEST);
        $request->getHeaderLine(Cookies::COOKIE_HEADER)->willReturn($cookieString);

        $cookies = Cookies::fromRequest($request->reveal());

        $this->assertEquals($expectedCookies, $cookies->getAll());
    }

Here is the call graph for this function:

it_gets_and_updates_cookie_value_on_request()

Dflydev\FigCookies\CookiesTest::it_gets_and_updates_cookie_value_on_request

(

)

Test:

Definition at line 148 of file CookiesTest.php.

References Dflydev\FigCookies\Cookies\COOKIE_HEADER, Dflydev\FigCookies\Cookies\fromRequest(), and Dflydev\FigCookies\withHeader().

    {
        //
        // Example of naive cookie decryption middleware.
        //
        // Shows how to access and manipulate cookies using PSR-7 Request
        // instances from outside the Request object itself.
        //

        // Simulate a request coming in with several cookies.
        $request = (new FigCookieTestingRequest())
            ->withHeader(Cookies::COOKIE_HEADER, 'theme=light; sessionToken=RAPELCGRQ; hello=world')
        ;

        // Get our cookies from the request.
        $cookies = Cookies::fromRequest($request);

        // Ask for the encrypted session token.
        $encryptedSessionToken = $cookies->get('sessionToken');

        // Get the encrypted value from the cookie and decrypt it.
        $encryptedValue = $encryptedSessionToken->getValue();
        $decryptedValue = str_rot13($encryptedValue);

        // Create a new cookie with the decrypted value.
        $decryptedSessionToken = $encryptedSessionToken->withValue($decryptedValue);

        // Include our decrypted session token with the rest of our cookies.
        $cookies = $cookies->with($decryptedSessionToken);

        // Render our cookies, along with the newly decrypted session token, into a request.
        $request = $cookies->renderIntoCookieHeader($request);

        // From this point on, any request based on this one can get the plaintext version
        // of the session token.
        $this->assertEquals(
            'theme=light; sessionToken=ENCRYPTED; hello=world',
            $request->getHeaderLine(Cookies::COOKIE_HEADER)
        );
    }

Here is the call graph for this function:

it_gets_cookie_by_name()

Dflydev\FigCookies\CookiesTest::it_gets_cookie_by_name	(		$cookieString,
			$cookieName,
		Cookie	$expectedCookie
	)

Test:

provideGetsCookieByNameData

Definition at line 62 of file CookiesTest.php.

References $cookieName, and Dflydev\FigCookies\Cookies\fromCookieString().

    {
        $cookies = Cookies::fromCookieString($cookieString);

        $this->assertEquals($expectedCookie, $cookies->get($cookieName));
    }

Here is the call graph for this function:

it_gets_cookie_value_from_request()

Dflydev\FigCookies\CookiesTest::it_gets_cookie_value_from_request

(

)

Test:

Definition at line 129 of file CookiesTest.php.

References Dflydev\FigCookies\Cookies\COOKIE_HEADER, Dflydev\FigCookies\Cookies\fromRequest(), and Dflydev\FigCookies\withHeader().

    {
        //
        // Example of accessing a cookie value.
        //

        // Simulate a request coming in with several cookies.
        $request = (new FigCookieTestingRequest())
            ->withHeader(Cookies::COOKIE_HEADER, 'theme=light; sessionToken=RAPELCGRQ; hello=world')
        ;

        $theme = Cookies::fromRequest($request)->get('theme')->getValue();

        $this->assertEquals('light', $theme);
    }

Here is the call graph for this function:

it_knows_which_cookies_are_available()

Dflydev\FigCookies\CookiesTest::it_knows_which_cookies_are_available	(		$cookieString,
		array	$expectedCookies
	)

Parameters

string[]	$cookieString
Cookie[]	$expectedCookies

Test:

provideCookieStringAndExpectedCookiesData

Definition at line 47 of file CookiesTest.php.

References Dflydev\FigCookies\Cookies\fromCookieString().

    {
        $cookies = Cookies::fromCookieString($cookieString);

        foreach ($expectedCookies as $expectedCookie) {
            $this->assertTrue($cookies->has($expectedCookie->getName()));
        }

        $this->assertFalse($cookies->has('i know this cookie does not exist'));
    }

Here is the call graph for this function:

it_renders_added_and_removed_cookies_header()

Dflydev\FigCookies\CookiesTest::it_renders_added_and_removed_cookies_header

(

)

Test:

Definition at line 110 of file CookiesTest.php.

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

    {
        $cookies = Cookies::fromCookieString('theme=light; sessionToken=abc123; hello=world')
            ->with(Cookie::create('theme', 'blue'))
            ->without('sessionToken')
            ->with(Cookie::create('who', 'me'))
        ;

        $originalRequest = new FigCookieTestingRequest();
        $request = $cookies->renderIntoCookieHeader($originalRequest);

        $this->assertNotEquals($request, $originalRequest);

        $this->assertEquals('theme=blue; hello=world; who=me', $request->getHeaderLine(Cookies::COOKIE_HEADER));
    }

Here is the call graph for this function:

it_renders_new_cookies_into_empty_cookie_header()

Dflydev\FigCookies\CookiesTest::it_renders_new_cookies_into_empty_cookie_header

(

)

Test:

Definition at line 92 of file CookiesTest.php.

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

    {
        $cookies = (new Cookies())
            ->with(Cookie::create('theme', 'light'))
            ->with(Cookie::create('sessionToken', 'abc123'))
        ;

        $originalRequest = new FigCookieTestingRequest();
        $request = $cookies->renderIntoCookieHeader($originalRequest);

        $this->assertNotEquals($request, $originalRequest);

        $this->assertEquals('theme=light; sessionToken=abc123', $request->getHeaderLine(Cookies::COOKIE_HEADER));
    }

Here is the call graph for this function:

it_sets_overrides_and_removes_cookie()

Dflydev\FigCookies\CookiesTest::it_sets_overrides_and_removes_cookie

(

)

Test:

Definition at line 72 of file CookiesTest.php.

References Dflydev\FigCookies\Cookie\create().

    {
        $cookies = new Cookies();

        $cookies = $cookies->with(Cookie::create('theme', 'blue'));

        $this->assertEquals('blue', $cookies->get('theme')->getValue());

        $cookies = $cookies->with(Cookie::create('theme', 'red'));

        $this->assertEquals('red', $cookies->get('theme')->getValue());

        $cookies = $cookies->without('theme');

        $this->assertFalse($cookies->has('theme'));
    }

Here is the call graph for this function:

provideCookieStringAndExpectedCookiesData()

Dflydev\FigCookies\CookiesTest::provideCookieStringAndExpectedCookiesData

(

)

Definition at line 189 of file CookiesTest.php.

References Dflydev\FigCookies\Cookie\create().

    {
        return [
            [
                '',
                []
            ],
            [
                'theme=light',
                [
                    Cookie::create('theme', 'light'),
                ]
            ],
            [
                'theme=light; sessionToken=abc123',
                [
                    Cookie::create('theme', 'light'),
                    Cookie::create('sessionToken', 'abc123'),
                ]
            ]
        ];
    }

Here is the call graph for this function:

provideGetsCookieByNameData()

Dflydev\FigCookies\CookiesTest::provideGetsCookieByNameData

(

)

Definition at line 212 of file CookiesTest.php.

References Dflydev\FigCookies\Cookie\create().

    {
        return [
            ['theme=light', 'theme', Cookie::create('theme', 'light')],
            ['theme=', 'theme', Cookie::create('theme')],
            ['hello=world; theme=light; sessionToken=abc123', 'theme', Cookie::create('theme', 'light')],
            ['hello=world; theme=; sessionToken=abc123', 'theme', Cookie::create('theme')],
        ];
    }

Here is the call graph for this function:

Field Documentation

INTERFACE_PSR_HTTP_MESSAGE_REQUEST

const Dflydev\FigCookies\CookiesTest::INTERFACE_PSR_HTTP_MESSAGE_REQUEST = 'Psr\Http\Message\RequestInterface'

Definition at line 7 of file CookiesTest.php.

---

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

• libs/composer/vendor/dflydev/fig-cookies/tests/Dflydev/FigCookies/CookiesTest.php