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 ()
	@inheritDoc More...
	getValue ()
	@inheritDoc More...
	getExpires ()
	@inheritDoc More...
	getMaxAge ()
	@inheritDoc More...
	getPath ()
	@inheritDoc More...
	getDomain ()
	@inheritDoc More...
	getSecure ()
	@inheritDoc More...
	getHttpOnly ()
	@inheritDoc 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...
	__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...
	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...
	__toString ()
	Returns the string representation of the object. 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.

    {
        $this->cookie = $cookie;
    }

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

Member Function Documentation

__toString()

ILIAS\HTTP\Cookies\CookieWrapper::__toString

(

)

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 222 of file CookieWrapper.php.

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

expire()

ILIAS\HTTP\Cookies\CookieWrapper::expire

(

)

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 150 of file CookieWrapper.php.

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

    {
        return $this->cookie;
    }

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

getMaxAge()

ILIAS\HTTP\Cookies\CookieWrapper::getMaxAge

(

)

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 69 of file CookieWrapper.php.

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

getName()

ILIAS\HTTP\Cookies\CookieWrapper::getName

(

)

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 42 of file CookieWrapper.php.

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

getPath()

ILIAS\HTTP\Cookies\CookieWrapper::getPath

(

)

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 78 of file CookieWrapper.php.

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

getSecure()

ILIAS\HTTP\Cookies\CookieWrapper::getSecure

(

)

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 96 of file CookieWrapper.php.

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

getValue()

ILIAS\HTTP\Cookies\CookieWrapper::getValue

(

)

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 51 of file CookieWrapper.php.

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

rememberForLongTime()

ILIAS\HTTP\Cookies\CookieWrapper::rememberForLongTime

(

)

@inheritDoc

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

)

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 186 of file CookieWrapper.php.

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

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

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

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

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

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

Here is the call graph for this function:

withSecure()

ILIAS\HTTP\Cookies\CookieWrapper::withSecure

(

bool

$secure = null

)

@inheritDoc

Implements ILIAS\HTTP\Cookies\Cookie.

Definition at line 198 of file CookieWrapper.php.

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

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

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