ILIAS\HTTP\Cookies\CookieWrapper Class Reference

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 ()
	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)
	__toString ()
	getImplementation ()
	Returns the underlying implementation. More...

Private Attributes
	$cookie
	Underlying implementation. More...

Detailed Description

Definition at line 17 of file CookieWrapper.php.

Constructor & Destructor Documentation

__construct()

ILIAS\HTTP\Cookies\CookieWrapper::__construct

(

SetCookie

$cookie

)

CookieFacade constructor.

Parameters

SetCookie

$cookie

Definition at line 33 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 222 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().

                             : \ILIAS\HTTP\Cookies\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 60 of file CookieWrapper.php.

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

getHttpOnly()

ILIAS\HTTP\Cookies\CookieWrapper::getHttpOnly

(

)

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 105 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!!!

Returns

SetCookie

Definition at line 235 of file CookieWrapper.php.

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

    {
        return $this->cookie;
    }

getMaxAge()

ILIAS\HTTP\Cookies\CookieWrapper::getMaxAge

(

)

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 69 of file CookieWrapper.php.

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

getName()

ILIAS\HTTP\Cookies\CookieWrapper::getName

(

)

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 42 of file CookieWrapper.php.

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

getPath()

ILIAS\HTTP\Cookies\CookieWrapper::getPath

(

)

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 78 of file CookieWrapper.php.

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

getSecure()

ILIAS\HTTP\Cookies\CookieWrapper::getSecure

(

)

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 96 of file CookieWrapper.php.

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

getValue()

ILIAS\HTTP\Cookies\CookieWrapper::getValue

(

)

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 51 of file CookieWrapper.php.

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

rememberForLongTime()

ILIAS\HTTP\Cookies\CookieWrapper::rememberForLongTime

(

)

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 138 of file CookieWrapper.php.

                                          : \ILIAS\HTTP\Cookies\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 186 of file CookieWrapper.php.

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

                                                      : \ILIAS\HTTP\Cookies\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 126 of file CookieWrapper.php.

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

                                                 : \ILIAS\HTTP\Cookies\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 210 of file CookieWrapper.php.

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

                                                        : \ILIAS\HTTP\Cookies\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 162 of file CookieWrapper.php.

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

                                                   : \ILIAS\HTTP\Cookies\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 174 of file CookieWrapper.php.

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

                                                  : \ILIAS\HTTP\Cookies\Cookie
    {
        $clone = clone $this;
        $clone->cookie = $this->cookie->withPath($path);

        return $clone;
    }

Here is the call graph for this function:

withSecure()

ILIAS\HTTP\Cookies\CookieWrapper::withSecure

(

bool

$secure = null

)

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 198 of file CookieWrapper.php.

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

                                                    : \ILIAS\HTTP\Cookies\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 114 of file CookieWrapper.php.

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

                                                    : \ILIAS\HTTP\Cookies\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

Underlying implementation.

Definition at line 25 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:

• src/HTTP/Cookies/CookieWrapper.php