ILIAS\HTTP\Cookies\CookieJar Interface Reference
Inheritance diagram for ILIAS\HTTP\Cookies\CookieJar:
Collaboration diagram for ILIAS\HTTP\Cookies\CookieJar:
Public Member Functions | |
| has ($name) | |
| Checks if a cookie with the given name is in the jar. More... | |
| get ($name) | |
| Fetches the cookie with the given name from the current jar. More... | |
| getAll () | |
| Fetches all cookies from the current jar. More... | |
| with (Cookie $setCookie) | |
| Creates a new cookie jar with the given cookie. More... | |
| without ($name) | |
| Creates a cookie jar without the specified cookie. More... | |
| renderIntoResponseHeader (ResponseInterface $response) | |
| Render CookieJar into a Response. More... | |
Detailed Description
Definition at line 24 of file CookieJar.php.
Member Function Documentation
◆ get()
| ILIAS\HTTP\Cookies\CookieJar::get | ( | $name | ) |
Fetches the cookie with the given name from the current jar.
If no cookie could be found, null is returned.
- Parameters
-
string $name Name of the cookie which should be returned.
- Returns
- Cookie | null
Implemented in ILIAS\HTTP\Cookies\CookieJarWrapper.
◆ getAll()
| ILIAS\HTTP\Cookies\CookieJar::getAll | ( | ) |
Fetches all cookies from the current jar.
- Returns
- Cookie[]
Implemented in ILIAS\HTTP\Cookies\CookieJarWrapper.
◆ has()
| ILIAS\HTTP\Cookies\CookieJar::has | ( | $name | ) |
Checks if a cookie with the given name is in the jar.
- Parameters
-
string $name Cookie name.
- Returns
- bool True if the cookie exists otherwise false.
Implemented in ILIAS\HTTP\Cookies\CookieJarWrapper.
◆ renderIntoResponseHeader()
| ILIAS\HTTP\Cookies\CookieJar::renderIntoResponseHeader | ( | ResponseInterface | $response | ) |
Render CookieJar into a Response.
- Parameters
-
ResponseInterface $response
- Returns
- ResponseInterface
Implemented in ILIAS\HTTP\Cookies\CookieJarWrapper.
◆ with()
| ILIAS\HTTP\Cookies\CookieJar::with | ( | Cookie | $setCookie | ) |
Creates a new cookie jar with the given cookie.
- Parameters
-
Cookie $setCookie The cookie which should be added to the jar.
- Returns
- CookieJar New cookie jar which holds the new cookie.
Referenced by ILIAS\HTTP\Cookies\CookieJarWrapper\getAll().
Here is the caller graph for this function:
◆ without()
| ILIAS\HTTP\Cookies\CookieJar::without | ( | $name | ) |
Creates a cookie jar without the specified cookie.
- Parameters
-
string $name Cookie name.
- Returns
- CookieJar New cookie jar.
Implemented in ILIAS\HTTP\Cookies\CookieJarWrapper.
The documentation for this interface was generated from the following file:
- src/HTTP/Cookies/CookieJar.php
