Dflydev\FigCookies\SetCookie Class Reference

Collaboration diagram for Dflydev\FigCookies\SetCookie:

Public Member Functions
	getName ()
	getValue ()
	getExpires ()
	getMaxAge ()
	getPath ()
	getDomain ()
	getSecure ()
	getHttpOnly ()
	withValue ($value=null)
	withExpires ($expires=null)
	rememberForever ()
	expire ()
	withMaxAge ($maxAge=null)
	withPath ($path=null)
	withDomain ($domain=null)
	withSecure ($secure=null)
	withHttpOnly ($httpOnly=null)
	__toString ()

Static Public Member Functions
static	create ($name, $value=null)
static	createRememberedForever ($name, $value=null)
static	createExpired ($name)

Private Member Functions
	__construct ($name, $value=null)
	resolveExpires ($expires=null)
	appendFormattedDomainPartIfSet (array $cookieStringParts)
	appendFormattedPathPartIfSet (array $cookieStringParts)
	appendFormattedExpiresPartIfSet (array $cookieStringParts)
	appendFormattedMaxAgePartIfSet (array $cookieStringParts)
	appendFormattedSecurePartIfSet (array $cookieStringParts)
	appendFormattedHttpOnlyPartIfSet (array $cookieStringParts)

Private Attributes
	$name
	$value
	$expires = 0
	$maxAge = 0
	$path
	$domain
	$secure = false
	$httpOnly = false

Detailed Description

Definition at line 8 of file SetCookie.php.

Constructor & Destructor Documentation

__construct()

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

private

Definition at line 19 of file SetCookie.php.

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

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

Member Function Documentation

__toString()

Dflydev\FigCookies\SetCookie::__toString

(

)

Definition at line 157 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\appendFormattedDomainPartIfSet(), Dflydev\FigCookies\SetCookie\appendFormattedExpiresPartIfSet(), Dflydev\FigCookies\SetCookie\appendFormattedHttpOnlyPartIfSet(), Dflydev\FigCookies\SetCookie\appendFormattedMaxAgePartIfSet(), Dflydev\FigCookies\SetCookie\appendFormattedPathPartIfSet(), and Dflydev\FigCookies\SetCookie\appendFormattedSecurePartIfSet().

    {
        $cookieStringParts = [
            urlencode($this->name).'='.urlencode($this->value),
        ];

        $cookieStringParts = $this->appendFormattedDomainPartIfSet($cookieStringParts);
        $cookieStringParts = $this->appendFormattedPathPartIfSet($cookieStringParts);
        $cookieStringParts = $this->appendFormattedExpiresPartIfSet($cookieStringParts);
        $cookieStringParts = $this->appendFormattedMaxAgePartIfSet($cookieStringParts);
        $cookieStringParts = $this->appendFormattedSecurePartIfSet($cookieStringParts);
        $cookieStringParts = $this->appendFormattedHttpOnlyPartIfSet($cookieStringParts);

        return implode('; ', $cookieStringParts);
    }

Here is the call graph for this function:

appendFormattedDomainPartIfSet()

Dflydev\FigCookies\SetCookie::appendFormattedDomainPartIfSet ( array  $cookieStringParts )

private

Definition at line 234 of file SetCookie.php.

Referenced by Dflydev\FigCookies\SetCookie\__toString().

    {
        if ($this->domain) {
            $cookieStringParts[] = sprintf("Domain=%s", $this->domain);
        }

        return $cookieStringParts;
    }

Here is the caller graph for this function:

appendFormattedExpiresPartIfSet()

Dflydev\FigCookies\SetCookie::appendFormattedExpiresPartIfSet ( array  $cookieStringParts )

private

Definition at line 252 of file SetCookie.php.

Referenced by Dflydev\FigCookies\SetCookie\__toString().

    {
        if ($this->expires) {
            $cookieStringParts[] = sprintf("Expires=%s", gmdate('D, d M Y H:i:s T', $this->expires));
        }

        return $cookieStringParts;
    }

Here is the caller graph for this function:

appendFormattedHttpOnlyPartIfSet()

Dflydev\FigCookies\SetCookie::appendFormattedHttpOnlyPartIfSet ( array  $cookieStringParts )

private

Definition at line 279 of file SetCookie.php.

Referenced by Dflydev\FigCookies\SetCookie\__toString().

    {
        if ($this->httpOnly) {
            $cookieStringParts[] = 'HttpOnly';
        }

        return $cookieStringParts;
    }

Here is the caller graph for this function:

appendFormattedMaxAgePartIfSet()

Dflydev\FigCookies\SetCookie::appendFormattedMaxAgePartIfSet ( array  $cookieStringParts )

private

Definition at line 261 of file SetCookie.php.

Referenced by Dflydev\FigCookies\SetCookie\__toString().

    {
        if ($this->maxAge) {
            $cookieStringParts[] = sprintf("Max-Age=%s", $this->maxAge);
        }

        return $cookieStringParts;
    }

Here is the caller graph for this function:

appendFormattedPathPartIfSet()

Dflydev\FigCookies\SetCookie::appendFormattedPathPartIfSet ( array  $cookieStringParts )

private

Definition at line 243 of file SetCookie.php.

Referenced by Dflydev\FigCookies\SetCookie\__toString().

    {
        if ($this->path) {
            $cookieStringParts[] = sprintf("Path=%s", $this->path);
        }

        return $cookieStringParts;
    }

Here is the caller graph for this function:

appendFormattedSecurePartIfSet()

Dflydev\FigCookies\SetCookie::appendFormattedSecurePartIfSet ( array  $cookieStringParts )

private

Definition at line 270 of file SetCookie.php.

Referenced by Dflydev\FigCookies\SetCookie\__toString().

    {
        if ($this->secure) {
            $cookieStringParts[] = 'Secure';
        }

        return $cookieStringParts;
    }

Here is the caller graph for this function:

create()

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

static

Definition at line 173 of file SetCookie.php.

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

Referenced by ILIAS\HTTP\Cookies\CookieFactoryImpl\create(), Dflydev\FigCookies\FigResponseCookies\get(), Dflydev\FigCookies\FigCookiesTest\it_encrypts_and_decrypts_cookies(), Dflydev\FigCookies\FigResponseCookiesTest\it_gets_cookies(), Dflydev\FigCookies\FigResponseCookiesTest\it_modifies_cookies(), Dflydev\FigCookies\FigResponseCookiesTest\it_removes_cookies(), Dflydev\FigCookies\SetCookiesTest\it_renders_added_and_removed_set_cookies_header(), Dflydev\FigCookies\FigResponseCookiesTest\it_sets_cookies(), Dflydev\FigCookies\FigResponseCookies\modify(), Dflydev\FigCookies\SetCookiesTest\provideGetsSetCookieByNameData(), Dflydev\FigCookies\SetCookieTest\provideParsesFromSetCookieStringData(), and Dflydev\FigCookies\SetCookiesTest\provideSetCookieStringsAndExpectedSetCookiesData().

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

Here is the caller graph for this function:

createExpired()

static Dflydev\FigCookies\SetCookie::createExpired (   $name )

static

Definition at line 183 of file SetCookie.php.

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

Referenced by ILIAS\HTTP\Cookies\CookieFactoryImpl\createExpired(), Dflydev\FigCookies\FigResponseCookies\expire(), and Dflydev\FigCookies\SetCookieTest\it_expires_cookies().

    {
        return static::create($name)->expire();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createRememberedForever()

static Dflydev\FigCookies\SetCookie::createRememberedForever (   $name,   $value = null  )

static

Definition at line 178 of file SetCookie.php.

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

Referenced by ILIAS\HTTP\Cookies\CookieFactoryImpl\createRememberedForLongTime(), and Dflydev\FigCookies\SetCookieTest\it_creates_long_living_cookies().

    {
        return static::create($name, $value)->rememberForever();
    }

Here is the caller graph for this function:

expire()

Dflydev\FigCookies\SetCookie::expire

(

)

Definition at line 107 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\withExpires().

    {
        return $this->withExpires(new DateTime('-5 years'));
    }

Here is the call graph for this function:

getDomain()

Dflydev\FigCookies\SetCookie::getDomain

(

)

Definition at line 50 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\$domain.

    {
        return $this->domain;
    }

getExpires()

Dflydev\FigCookies\SetCookie::getExpires

(

)

Definition at line 35 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\$expires.

    {
        return $this->expires;
    }

getHttpOnly()

Dflydev\FigCookies\SetCookie::getHttpOnly

(

)

Definition at line 60 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\$httpOnly.

    {
        return $this->httpOnly;
    }

getMaxAge()

Dflydev\FigCookies\SetCookie::getMaxAge

(

)

Definition at line 40 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\$maxAge.

    {
        return $this->maxAge;
    }

getName()

Dflydev\FigCookies\SetCookie::getName

(

)

Definition at line 25 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\$name.

Referenced by Dflydev\FigCookies\FigResponseCookiesTest\it_modifies_cookies(), and Dflydev\FigCookies\SetCookies\with().

    {
        return $this->name;
    }

Here is the caller graph for this function:

getPath()

Dflydev\FigCookies\SetCookie::getPath

(

)

Definition at line 45 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\$path.

    {
        return $this->path;
    }

getSecure()

Dflydev\FigCookies\SetCookie::getSecure

(

)

Definition at line 55 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\$secure.

    {
        return $this->secure;
    }

getValue()

Dflydev\FigCookies\SetCookie::getValue

(

)

Definition at line 30 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\$value.

Referenced by Dflydev\FigCookies\FigCookiesTest\it_encrypts_and_decrypts_cookies().

    {
        return $this->value;
    }

Here is the caller graph for this function:

rememberForever()

Dflydev\FigCookies\SetCookie::rememberForever

(

)

Definition at line 102 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\withExpires().

    {
        return $this->withExpires(new DateTime('+5 years'));
    }

Here is the call graph for this function:

resolveExpires()

Dflydev\FigCookies\SetCookie::resolveExpires (   $expires = null )

private

Definition at line 74 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\$expires.

Referenced by Dflydev\FigCookies\SetCookie\withExpires().

    {
        if (is_null($expires)) {
            return null;
        }

        if ($expires instanceof DateTime || $expires instanceof DateTimeInterface) {
            return $expires->getTimestamp();
        }

        if (is_numeric($expires)) {
            return $expires;
        }

        return strtotime($expires);
    }

Here is the caller graph for this function:

withDomain()

Dflydev\FigCookies\SetCookie::withDomain

(

$domain = null

)

Definition at line 130 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\$domain.

    {
        $clone = clone($this);

        $clone->domain = $domain;

        return $clone;
    }

withExpires()

Dflydev\FigCookies\SetCookie::withExpires

(

$expires = null

)

Definition at line 91 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\$expires, and Dflydev\FigCookies\SetCookie\resolveExpires().

Referenced by Dflydev\FigCookies\SetCookie\expire(), and Dflydev\FigCookies\SetCookie\rememberForever().

    {
        $expires = $this->resolveExpires($expires);

        $clone = clone($this);

        $clone->expires = $expires;

        return $clone;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

withHttpOnly()

Dflydev\FigCookies\SetCookie::withHttpOnly

(

$httpOnly = null

)

Definition at line 148 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\$httpOnly.

    {
        $clone = clone($this);

        $clone->httpOnly = $httpOnly;

        return $clone;
    }

withMaxAge()

Dflydev\FigCookies\SetCookie::withMaxAge

(

$maxAge = null

)

Definition at line 112 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\$maxAge.

    {
        $clone = clone($this);

        $clone->maxAge = $maxAge;

        return $clone;
    }

withPath()

Dflydev\FigCookies\SetCookie::withPath

(

$path = null

)

Definition at line 121 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\$path.

    {
        $clone = clone($this);

        $clone->path = $path;

        return $clone;
    }

withSecure()

Dflydev\FigCookies\SetCookie::withSecure

(

$secure = null

)

Definition at line 139 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\$secure.

    {
        $clone = clone($this);

        $clone->secure = $secure;

        return $clone;
    }

withValue()

Dflydev\FigCookies\SetCookie::withValue

(

$value = null

)

Definition at line 65 of file SetCookie.php.

References Dflydev\FigCookies\SetCookie\$value.

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

    {
        $clone = clone($this);

        $clone->value = $value;

        return $clone;
    }

Here is the caller graph for this function:

Field Documentation

$domain

Dflydev\FigCookies\SetCookie::$domain

private

Definition at line 15 of file SetCookie.php.

Referenced by Dflydev\FigCookies\SetCookie\getDomain(), and Dflydev\FigCookies\SetCookie\withDomain().

$expires

Dflydev\FigCookies\SetCookie::$expires = 0

private

Definition at line 12 of file SetCookie.php.

Referenced by Dflydev\FigCookies\SetCookie\getExpires(), Dflydev\FigCookies\SetCookie\resolveExpires(), and Dflydev\FigCookies\SetCookie\withExpires().

$httpOnly

Dflydev\FigCookies\SetCookie::$httpOnly = false

private

Definition at line 17 of file SetCookie.php.

Referenced by Dflydev\FigCookies\SetCookie\getHttpOnly(), and Dflydev\FigCookies\SetCookie\withHttpOnly().

$maxAge

Dflydev\FigCookies\SetCookie::$maxAge = 0

private

Definition at line 13 of file SetCookie.php.

Referenced by Dflydev\FigCookies\SetCookie\getMaxAge(), and Dflydev\FigCookies\SetCookie\withMaxAge().

$name

Dflydev\FigCookies\SetCookie::$name

private

Definition at line 10 of file SetCookie.php.

Referenced by Dflydev\FigCookies\SetCookie\__construct(), Dflydev\FigCookies\SetCookie\create(), Dflydev\FigCookies\SetCookie\createExpired(), Dflydev\FigCookies\SetCookie\createRememberedForever(), and Dflydev\FigCookies\SetCookie\getName().

$path

Dflydev\FigCookies\SetCookie::$path

private

Definition at line 14 of file SetCookie.php.

Referenced by Dflydev\FigCookies\SetCookie\getPath(), and Dflydev\FigCookies\SetCookie\withPath().

$secure

Dflydev\FigCookies\SetCookie::$secure = false

private

Definition at line 16 of file SetCookie.php.

Referenced by Dflydev\FigCookies\SetCookie\getSecure(), and Dflydev\FigCookies\SetCookie\withSecure().

$value

Dflydev\FigCookies\SetCookie::$value

private

Definition at line 11 of file SetCookie.php.

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

---

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

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