ILIAS  trunk Revision v11.0_alpha-1811-gd2d5443e411
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
ilCookie Class Reference

Representation of an HTTP cookie. More...

+ Collaboration diagram for ilCookie:

Public Member Functions

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

Private Attributes

string $name
 
string $value = ''
 
int $expire = 0
 
string $path = ''
 
string $domain = ''
 
bool $secure = false
 
bool $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 27 of file class.ilCookie.php.

Constructor & Destructor Documentation

◆ __construct()

ilCookie::__construct ( string  $a_name)

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

38  {
39  $this->name = $a_name;
40  }

Member Function Documentation

◆ getDomain()

ilCookie::getDomain ( )

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

References $domain.

94  : string
95  {
96  return $this->domain;
97  }
string $domain

◆ getExpire()

ilCookie::getExpire ( )

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

References $expire.

74  : int
75  {
76  return $this->expire;
77  }

◆ getName()

ilCookie::getName ( )

Get name.

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

References $name.

50  : string
51  {
52  return $this->name;
53  }
string $name

◆ getPath()

ilCookie::getPath ( )

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

References $path.

84  : string
85  {
86  return $this->path;
87  }
string $path

◆ getValue()

ilCookie::getValue ( )

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

References $value.

64  : string
65  {
66  return $this->value;
67  }
string $value

◆ isHttpOnly()

ilCookie::isHttpOnly ( )

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

References $http_only.

114  : bool
115  {
116  return $this->http_only;
117  }
bool $http_only

◆ isSecure()

ilCookie::isSecure ( )

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

References $secure.

104  : bool
105  {
106  return $this->secure;
107  }

◆ setDomain()

ilCookie::setDomain ( string  $a_domain)

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

89  : void
90  {
91  $this->domain = $a_domain;
92  }

◆ setExpire()

ilCookie::setExpire ( int  $a_expire)

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

69  : void
70  {
71  $this->expire = $a_expire;
72  }

◆ setHttpOnly()

ilCookie::setHttpOnly ( bool  $a_http_only)

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

109  : void
110  {
111  $this->http_only = $a_http_only;
112  }

◆ setName()

ilCookie::setName ( string  $a_name)

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

42  : void
43  {
44  $this->name = $a_name;
45  }

◆ setPath()

ilCookie::setPath ( string  $a_path)

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

79  : void
80  {
81  $this->path = $a_path;
82  }

◆ setSecure()

ilCookie::setSecure ( bool  $a_status)

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

99  : void
100  {
101  $this->secure = $a_status;
102  }

◆ setValue()

ilCookie::setValue ( string  $a_value)

Currently no restriction on cookie length.

RFC 2965 suggests a minimum of 4096 bytes

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

59  : void
60  {
61  $this->value = $a_value;
62  }

Field Documentation

◆ $domain

string ilCookie::$domain = ''
private

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

Referenced by getDomain().

◆ $expire

int ilCookie::$expire = 0
private

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

Referenced by getExpire().

◆ $http_only

bool ilCookie::$http_only = false
private

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

Referenced by isHttpOnly().

◆ $name

string ilCookie::$name
private

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

Referenced by getName().

◆ $path

string ilCookie::$path = ''
private

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

Referenced by getPath().

◆ $secure

bool ilCookie::$secure = false
private

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

Referenced by isSecure().

◆ $value

string ilCookie::$value = ''
private

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

Referenced by getValue().


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