Dflydev\FigCookies\Cookie Class Reference

Collaboration diagram for Dflydev\FigCookies\Cookie:

Public Member Functions
	__construct ($name, $value=null)
	getName ()
	getValue ()
	withValue ($value=null)
	__toString ()
	Render Cookie as a string. More...

Static Public Member Functions
static	create ($name, $value=null)
	Create a Cookie. More...
static	listFromCookieString ($string)
	Create a list of Cookies from a Cookie header value string. More...

Private Attributes
	$name
	$value

Detailed Description

Definition at line 5 of file Cookie.php.

Constructor & Destructor Documentation

__construct()

Dflydev\FigCookies\Cookie::__construct	(		$name,
			$value = null
	)

Parameters

string	$name
string | null	$value

Definition at line 21 of file Cookie.php.

References Dflydev\FigCookies\Cookie\$name, and Dflydev\FigCookies\Cookie\$value.

    {
        $this->name = $name;
        $this->value = $value;
    }

Member Function Documentation

__toString()

Dflydev\FigCookies\Cookie::__toString

(

)

Render Cookie as a string.

Returns

string

Definition at line 61 of file Cookie.php.

    {
        return urlencode($this->name).'='.urlencode($this->value);
    }

create()

static Dflydev\FigCookies\Cookie::create (   $name,   $value = null  )

static

Create a Cookie.

Parameters

string	$name
string | null	$value

Returns

Cookie

Definition at line 73 of file Cookie.php.

References Dflydev\FigCookies\Cookie\$name, and Dflydev\FigCookies\Cookie\$value.

Referenced by Dflydev\FigCookies\FigRequestCookies\get(), Dflydev\FigCookies\CookiesTest\it_renders_added_and_removed_cookies_header(), Dflydev\FigCookies\CookiesTest\it_renders_new_cookies_into_empty_cookie_header(), Dflydev\FigCookies\FigRequestCookiesTest\it_sets_cookies(), Dflydev\FigCookies\CookiesTest\it_sets_overrides_and_removes_cookie(), Dflydev\FigCookies\FigRequestCookies\modify(), Dflydev\FigCookies\CookiesTest\provideCookieStringAndExpectedCookiesData(), and Dflydev\FigCookies\CookiesTest\provideGetsCookieByNameData().

    {
        return new static($name, $value);
    }

Here is the caller graph for this function:

getName()

Dflydev\FigCookies\Cookie::getName

(

)

Returns

string

Definition at line 30 of file Cookie.php.

References Dflydev\FigCookies\Cookie\$name.

Referenced by Dflydev\FigCookies\CookieTest\assertCookieNameAndValue(), Dflydev\FigCookies\FigRequestCookiesTest\it_modifies_cookies(), and Dflydev\FigCookies\Cookies\with().

    {
        return $this->name;
    }

Here is the caller graph for this function:

getValue()

Dflydev\FigCookies\Cookie::getValue

(

)

Returns

string|null

Definition at line 38 of file Cookie.php.

References Dflydev\FigCookies\Cookie\$value.

Referenced by Dflydev\FigCookies\CookieTest\assertCookieNameAndValue(), and Dflydev\FigCookies\FigCookiesTest\it_encrypts_and_decrypts_cookies().

    {
        return $this->value;
    }

Here is the caller graph for this function:

listFromCookieString()

static Dflydev\FigCookies\Cookie::listFromCookieString (   $string )

static

Create a list of Cookies from a Cookie header value string.

Parameters

string

$string

Returns

Cookie[]

Definition at line 84 of file Cookie.php.

References $cookieName, Dflydev\FigCookies\StringUtil\splitCookiePair(), and Dflydev\FigCookies\StringUtil\splitOnAttributeDelimiter().

Referenced by Dflydev\FigCookies\Cookies\fromCookieString(), and Dflydev\FigCookies\CookieTest\it_parses_list_from_cookie_string().

    {
        $cookies = StringUtil::splitOnAttributeDelimiter($string);

        return array_map(function ($cookiePair) {
            return static::oneFromCookiePair($cookiePair);
        }, $cookies);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

withValue()

Dflydev\FigCookies\Cookie::withValue

(

$value = null

)

Parameters

string | null

$value

Returns

Cookie

Definition at line 47 of file Cookie.php.

References Dflydev\FigCookies\Cookie\$value.

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

    {
        $clone = clone($this);

        $clone->value = $value;

        return $clone;
    }

Here is the caller graph for this function:

Field Documentation

$name

Dflydev\FigCookies\Cookie::$name

private

Definition at line 10 of file Cookie.php.

Referenced by Dflydev\FigCookies\Cookie\__construct(), Dflydev\FigCookies\Cookie\create(), and Dflydev\FigCookies\Cookie\getName().

$value

Dflydev\FigCookies\Cookie::$value

private

Definition at line 15 of file Cookie.php.

Referenced by Dflydev\FigCookies\Cookie\__construct(), Dflydev\FigCookies\Cookie\create(), Dflydev\FigCookies\Cookie\getValue(), and Dflydev\FigCookies\Cookie\withValue().

---

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

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