Inheritance diagram for ILIAS\HTTP\Cookies\CookieWrapper:

Collaboration diagram for ILIAS\HTTP\Cookies\CookieWrapper:

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

	getName ()

	getValue ()

	getExpires ()

	getMaxAge ()

	getPath ()

	getDomain ()

	getSecure ()

	getHttpOnly ()

	getSamesite ()
	Cookie samesite. More...

	withValue (string $value=null)

	withExpires ($expires=null)

	rememberForLongTime ()

	expire ()

	withMaxAge (int $maxAge=null)

	withPath (string $path=null)

	withDomain (string $domain=null)

	withSecure (bool $secure=null)

	withHttpOnly (bool $httpOnly=null)

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

	__toString ()

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

Private Attributes
SetCookie	$cookie

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 ( SetCookie $cookie )

CookieFacade constructor.

Definition at line 39 of file CookieWrapper.php.

References ILIAS\HTTP\Cookies\CookieWrapper\$cookie.

     {
         $this->cookie = $cookie;
     }

Member Function Documentation

◆ __toString()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 224 of file CookieWrapper.php.

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

◆ expire()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 150 of file CookieWrapper.php.

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

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

Here is the call graph for this function:

◆ getDomain()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 87 of file CookieWrapper.php.

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

◆ getExpires()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 63 of file CookieWrapper.php.

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

◆ getHttpOnly()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 103 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 234 of file CookieWrapper.php.

References ILIAS\HTTP\Cookies\CookieWrapper\$cookie.

                                        : SetCookie
     {
         return $this->cookie;
     }

◆ getMaxAge()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 71 of file CookieWrapper.php.

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

◆ getName()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 47 of file CookieWrapper.php.

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

◆ getPath()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 79 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 108 of file CookieWrapper.php.

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

◆ getSecure()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 95 of file CookieWrapper.php.

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

◆ getValue()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 55 of file CookieWrapper.php.

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

◆ rememberForLongTime()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 139 of file CookieWrapper.php.

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

◆ withDomain()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 183 of file CookieWrapper.php.

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

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

Here is the call graph for this function:

◆ withExpires()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 128 of file CookieWrapper.php.

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

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

Here is the call graph for this function:

◆ withHttpOnly()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 205 of file CookieWrapper.php.

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

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

Here is the call graph for this function:

◆ withMaxAge()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 161 of file CookieWrapper.php.

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

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

Here is the call graph for this function:

◆ withPath()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 172 of file CookieWrapper.php.

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

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

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 SAMESITE_LAX, SAMESITE_STRICT or SAMESITE_NONE

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 213 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 )

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 194 of file CookieWrapper.php.

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

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

Here is the call graph for this function:

◆ withValue()

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

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 117 of file CookieWrapper.php.

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

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

Here is the call graph for this function:

Field Documentation

◆ $cookie

SetCookie ILIAS\HTTP\Cookies\CookieWrapper::$cookie

private

Definition at line 34 of file CookieWrapper.php.

Referenced by ILIAS\HTTP\Cookies\CookieWrapper\__construct(), and ILIAS\HTTP\Cookies\CookieWrapper\getImplementation().

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

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

Public Member Functions

Private Attributes

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()

Field Documentation

◆ $cookie