Inheritance diagram for ILIAS\HTTP\Cookies\CookieWrapper:

Collaboration diagram for ILIAS\HTTP\Cookies\CookieWrapper:

Public Member Functions
	__construct (private SetCookie $cookie)
	CookieFacade constructor. More...

	getName ()
	@inheritDoc More...

	getValue ()
	@inheritDoc More...

	getExpires ()
	@inheritDoc More...

	getMaxAge ()
	@inheritDoc More...

	getPath ()
	@inheritDoc More...

	getDomain ()
	@inheritDoc More...

	getSecure ()
	@inheritDoc More...

	getHttpOnly ()
	@inheritDoc More...

	getSamesite ()
	Cookie samesite. More...

	withValue (?string $value=null)
	@inheritDoc More...

	withExpires ($expires=null)
	@inheritDoc More...

	rememberForLongTime ()
	@inheritDoc More...

	expire ()
	@inheritDoc More...

	withMaxAge (?int $maxAge=null)
	@inheritDoc More...

	withPath (?string $path=null)
	@inheritDoc More...

	withDomain (?string $domain=null)
	@inheritDoc More...

	withSecure (?bool $secure=null)
	@inheritDoc More...

	withHttpOnly (?bool $httpOnly=null)
	@inheritDoc More...

	withSamesite (string $sameSite)
	Sets the samesite attribute. More...

	__toString ()
	@inheritDoc More...

	getImplementation ()
	Returns the underlying implementation. More...

	getName ()
	Cookie name. More...

	getValue ()
	Cookie value. More...

	getExpires ()
	Expiration date as unix timestamp. More...

	getMaxAge ()
	Max age measured in seconds. More...

	getPath ()
	Cookie path. More...

	getDomain ()
	Cookie domain. More...

	getSecure ()
	True if it's secure cookie otherwise false. More...

	getHttpOnly ()
	True if the cookie is http only otherwise false. More...

	getSamesite ()
	Cookie samesite. More...

	withValue (?string $value=null)
	Sets the cookie value. More...

	withExpires ($expires=null)
	Sets the expiration date of the cookie. More...

	rememberForLongTime ()
	Sets the expiration date to +5 years. More...

	expire ()
	Expire the cookie. More...

	withMaxAge (?int $maxAge=null)
	Maximal life time of the cookie in seconds. More...

	withPath (?string $path=null)
	Sets the cookie path. More...

	withDomain (?string $domain=null)
	Sets the domain name for the cookie. More...

	withSecure (?bool $secure=null)
	Sets if the cookie is a secure cookie or not. More...

	withHttpOnly (?bool $httpOnly=null)
	Sets if the cookie is http only. More...

	withSamesite (string $sameSite)
	Sets the samesite attribute. More...

	__toString ()
	Returns the string representation of the object. More...

Additional Inherited Members
Data Fields inherited from ILIAS\HTTP\Cookies\Cookie
const	SAMESITE_NONE = 'None'

const	SAMESITE_LAX = 'Lax'

const	SAMESITE_STRICT = 'Strict'

Detailed Description

Definition at line 32 of file CookieWrapper.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\HTTP\Cookies\CookieWrapper::__construct ( private SetCookie $cookie )

CookieFacade constructor.

Definition at line 37 of file CookieWrapper.php.

38 {

39 }

Member Function Documentation

◆ __toString()

ILIAS\HTTP\Cookies\CookieWrapper::__toString ( )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 221 of file CookieWrapper.php.

                                : string
    {
        return $this->cookie->__toString();
    }

◆ expire()

ILIAS\HTTP\Cookies\CookieWrapper::expire ( )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 147 of file CookieWrapper.php.

                            : Cookie
    {
        $clone = clone $this;
        $clone->cookie = $this->cookie->expire();
 
        return $clone;
    }

References ILIAS\HTTP\Cookies\Cookie\expire().

Here is the call graph for this function:

◆ getDomain()

ILIAS\HTTP\Cookies\CookieWrapper::getDomain ( )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 84 of file CookieWrapper.php.

                               : ?string
    {
        return $this->cookie->getDomain();
    }

◆ getExpires()

ILIAS\HTTP\Cookies\CookieWrapper::getExpires ( )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 60 of file CookieWrapper.php.

                                : int
    {
        return $this->cookie->getExpires();
    }

◆ getHttpOnly()

ILIAS\HTTP\Cookies\CookieWrapper::getHttpOnly ( )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 100 of file CookieWrapper.php.

                                 : bool
    {
        return $this->cookie->getHttpOnly();
    }

◆ getImplementation()

ILIAS\HTTP\Cookies\CookieWrapper::getImplementation ( )

Returns the underlying implementation.

Only for package/service internal use!!!

Definition at line 231 of file CookieWrapper.php.

                                       : SetCookie
    {
        return $this->cookie;
    }

◆ getMaxAge()

ILIAS\HTTP\Cookies\CookieWrapper::getMaxAge ( )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 68 of file CookieWrapper.php.

                               : int
    {
        return $this->cookie->getMaxAge();
    }

◆ getName()

ILIAS\HTTP\Cookies\CookieWrapper::getName ( )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 44 of file CookieWrapper.php.

                             : string
    {
        return $this->cookie->getName();
    }

◆ getPath()

ILIAS\HTTP\Cookies\CookieWrapper::getPath ( )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 76 of file CookieWrapper.php.

                             : ?string
    {
        return $this->cookie->getPath();
    }

◆ getSamesite()

ILIAS\HTTP\Cookies\CookieWrapper::getSamesite ( )

Cookie samesite.

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 105 of file CookieWrapper.php.

                                 : ?string
    {
        $samesite = $this->cookie->getSameSite();
        return is_null($samesite) ? null : $samesite->asString();
    }

◆ getSecure()

ILIAS\HTTP\Cookies\CookieWrapper::getSecure ( )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 92 of file CookieWrapper.php.

                               : bool
    {
        return $this->cookie->getSecure();
    }

◆ getValue()

ILIAS\HTTP\Cookies\CookieWrapper::getValue ( )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 52 of file CookieWrapper.php.

                              : ?string
    {
        return $this->cookie->getValue();
    }

◆ rememberForLongTime()

ILIAS\HTTP\Cookies\CookieWrapper::rememberForLongTime ( )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 136 of file CookieWrapper.php.

                                         : Cookie
    {
        $clone = clone $this;
        $clone->cookie = $this->cookie->rememberForever();
 
        return $clone;
    }

◆ withDomain()

ILIAS\HTTP\Cookies\CookieWrapper::withDomain ( ?string $domain = null )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 180 of file CookieWrapper.php.

                                                      : Cookie
    {
        $clone = clone $this;
        $clone->cookie = $this->cookie->withDomain($domain);
 
        return $clone;
    }

References ILIAS\HTTP\Cookies\Cookie\withDomain().

Here is the call graph for this function:

◆ withExpires()

ILIAS\HTTP\Cookies\CookieWrapper::withExpires ( $expires = null )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 125 of file CookieWrapper.php.

                                                : Cookie
    {
        $clone = clone $this;
        $clone->cookie = $this->cookie->withExpires($expires);
 
        return $clone;
    }

References ILIAS\HTTP\Cookies\Cookie\withExpires().

Here is the call graph for this function:

◆ withHttpOnly()

ILIAS\HTTP\Cookies\CookieWrapper::withHttpOnly ( ?bool $httpOnly = null )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 202 of file CookieWrapper.php.

                                                        : Cookie
    {
        $clone = clone $this;
        $clone->cookie = $this->cookie->withHttpOnly($httpOnly);
 
        return $clone;
    }

References ILIAS\HTTP\Cookies\Cookie\withHttpOnly().

Here is the call graph for this function:

◆ withMaxAge()

ILIAS\HTTP\Cookies\CookieWrapper::withMaxAge ( ?int $maxAge = null )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 158 of file CookieWrapper.php.

                                                   : Cookie
    {
        $clone = clone $this;
        $clone->cookie = $this->cookie->withMaxAge($maxAge);
 
        return $clone;
    }

References ILIAS\HTTP\Cookies\Cookie\withMaxAge().

Here is the call graph for this function:

◆ withPath()

ILIAS\HTTP\Cookies\CookieWrapper::withPath ( ?string $path = null )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 169 of file CookieWrapper.php.

                                                  : Cookie
    {
        $clone = clone $this;
        $clone->cookie = $this->cookie->withPath($path);
 
        return $clone;
    }

References $path, and ILIAS\HTTP\Cookies\Cookie\withPath().

Here is the call graph for this function:

◆ withSamesite()

ILIAS\HTTP\Cookies\CookieWrapper::withSamesite ( string $sameSite )

Sets the samesite attribute.

Parameters

string $sameSite value of the samesite attribute. Valid values are @const SAMESITE_LAX, @const SAMESITE_STRICT or @const SAMESITE_NONE

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 210 of file CookieWrapper.php.

                                                  : Cookie
    {
        $clone = clone $this;
        $clone->cookie = $this->cookie->withSameSite(SameSite::fromString($sameSite));
 
        return $clone;
    }

◆ withSecure()

ILIAS\HTTP\Cookies\CookieWrapper::withSecure ( ?bool $secure = null )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 191 of file CookieWrapper.php.

                                                    : Cookie
    {
        $clone = clone $this;
        $clone->cookie = $this->cookie->withSecure($secure);
 
        return $clone;
    }

References ILIAS\HTTP\Cookies\Cookie\withSecure().

Here is the call graph for this function:

◆ withValue()

ILIAS\HTTP\Cookies\CookieWrapper::withValue ( ?string $value = null )

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 114 of file CookieWrapper.php.

                                                    : Cookie
    {
        $clone = clone $this;
        $clone->cookie = $this->cookie->withValue($value);
 
        return $clone;
    }

References ILIAS\HTTP\Cookies\Cookie\withValue().

Here is the call graph for this function:

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

components/ILIAS/HTTP/src/Cookies/CookieWrapper.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ expire()

◆ getDomain()

◆ getExpires()

◆ getHttpOnly()

◆ getImplementation()

◆ getMaxAge()

◆ getName()

◆ getPath()

◆ getSamesite()

◆ getSecure()

◆ getValue()

◆ rememberForLongTime()

◆ withDomain()

◆ withExpires()

◆ withHttpOnly()

◆ withMaxAge()

◆ withPath()

◆ withSamesite()

◆ withSecure()

◆ withValue()