ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilCookie Class Reference

Representation of an HTTP cookie. More...

+ Collaboration diagram for ilCookie:

Public Member Functions

 __construct ($a_name)
 
 setName ($a_name)
 
 getName ()
 Get name. More...
 
 setValue ($a_value)
 Currently no restriction on cookie length. More...
 
 getValue ()
 
 setExpire ($a_expire)
 
 getExpire ()
 
 setPath ($a_path)
 
 getPath ()
 
 setDomain ($a_domain)
 
 getDomain ()
 
 setSecure ($a_status)
 
 isSecure ()
 
 setHttpOnly ($a_http_only)
 
 isHttpOnly ()
 

Private Attributes

 $name = ''
 
 $value = ''
 
 $expire = 0
 
 $path = ''
 
 $domain = ''
 
 $secure = false
 
 $http_only = false
 

Detailed Description

Representation of an HTTP cookie.

Author
Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 10 of file class.ilCookie.php.

Constructor & Destructor Documentation

◆ __construct()

ilCookie::__construct (   $a_name)

Definition at line 20 of file class.ilCookie.php.

References setName().

21  {
22  $this->setName($a_name);
23  }
setName($a_name)
+ Here is the call graph for this function:

Member Function Documentation

◆ getDomain()

ilCookie::getDomain ( )

Definition at line 79 of file class.ilCookie.php.

References $domain.

80  {
81  return $this->domain;
82  }

◆ getExpire()

ilCookie::getExpire ( )

Definition at line 59 of file class.ilCookie.php.

References $expire.

60  {
61  return $this->expire;
62  }

◆ getName()

ilCookie::getName ( )

Get name.

Returns
string

Definition at line 34 of file class.ilCookie.php.

References $name.

35  {
36  return $this->name;
37  }

◆ getPath()

ilCookie::getPath ( )

Definition at line 69 of file class.ilCookie.php.

References $path.

70  {
71  return $this->path;
72  }

◆ getValue()

ilCookie::getValue ( )

Definition at line 49 of file class.ilCookie.php.

References $value.

50  {
51  return $this->value;
52  }

◆ isHttpOnly()

ilCookie::isHttpOnly ( )

Definition at line 99 of file class.ilCookie.php.

References $http_only.

100  {
101  return $this->http_only;
102  }

◆ isSecure()

ilCookie::isSecure ( )

Definition at line 89 of file class.ilCookie.php.

References $secure.

90  {
91  return $this->secure;
92  }

◆ setDomain()

ilCookie::setDomain (   $a_domain)

Definition at line 74 of file class.ilCookie.php.

75  {
76  $this->domain = $a_domain;
77  }

◆ setExpire()

ilCookie::setExpire (   $a_expire)

Definition at line 54 of file class.ilCookie.php.

55  {
56  $this->expire = (int) $a_expire;
57  }

◆ setHttpOnly()

ilCookie::setHttpOnly (   $a_http_only)

Definition at line 94 of file class.ilCookie.php.

95  {
96  $this->http_only = $a_http_only;
97  }

◆ setName()

ilCookie::setName (   $a_name)

Definition at line 25 of file class.ilCookie.php.

Referenced by __construct().

26  {
27  $this->name = $a_name;
28  }
+ Here is the caller graph for this function:

◆ setPath()

ilCookie::setPath (   $a_path)

Definition at line 64 of file class.ilCookie.php.

65  {
66  $this->path = $a_path;
67  }

◆ setSecure()

ilCookie::setSecure (   $a_status)

Definition at line 84 of file class.ilCookie.php.

85  {
86  $this->secure = (bool) $a_status;
87  }

◆ setValue()

ilCookie::setValue (   $a_value)

Currently no restriction on cookie length.

RFC 2965 suggests a minimum of 4096 bytes

Parameters
string$a_value

Definition at line 44 of file class.ilCookie.php.

45  {
46  $this->value = $a_value;
47  }

Field Documentation

◆ $domain

ilCookie::$domain = ''
private

Definition at line 16 of file class.ilCookie.php.

Referenced by getDomain().

◆ $expire

ilCookie::$expire = 0
private

Definition at line 14 of file class.ilCookie.php.

Referenced by getExpire().

◆ $http_only

ilCookie::$http_only = false
private

Definition at line 18 of file class.ilCookie.php.

Referenced by isHttpOnly().

◆ $name

ilCookie::$name = ''
private

Definition at line 12 of file class.ilCookie.php.

Referenced by getName().

◆ $path

ilCookie::$path = ''
private

Definition at line 15 of file class.ilCookie.php.

Referenced by getPath().

◆ $secure

ilCookie::$secure = false
private

Definition at line 17 of file class.ilCookie.php.

Referenced by isSecure().

◆ $value

ilCookie::$value = ''
private

Definition at line 13 of file class.ilCookie.php.

Referenced by getValue().


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