HttpCookie
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\HttpCookie » CHttpCookie (opens new window) » CComponent (opens new window)
- Since
- 2.2
A HttpCookie instance stores a single cookie, including the cookie name, value, domain, path, expire time and whether it should be access over a secure connection or not.
.
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $domain (opens new window) | string (opens new window) – Domain of the cookie |
| $expire (opens new window) | integer (opens new window) – The timestamp at which the cookie expires. |
| $httpOnly (opens new window) | boolean (opens new window) – Whether the cookie should be accessible only through the HTTP protocol. |
| $name (opens new window) | string (opens new window) – Name of the cookie |
| $path (opens new window) | string (opens new window) – The path on the server in which the cookie will be available on. |
| $secure (opens new window) | boolean (opens new window) – Whether cookie should be sent via secure connection |
| $value (opens new window) | string (opens new window) – Value of the cookie |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __construct() | Creates a new HttpCookie instance. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __toString() (opens new window) | Magic method to use the cookie object as a string without having to call value property first. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| configure() (opens new window) | This method can be used to configure the CookieObject with an array Note: you cannot use this method to set the name and/or the value of the cookie |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| raiseEvent() (opens new window) | Raises an event. |
# __construct()
Creates a new HttpCookie instance.
View source (opens new window)
Arguments
$name(string (opens new window)) – The name of this cookie.$value(string (opens new window)) – The cookie's value.$options(array (opens new window)) – The configuration array consisting of name-value pairs that are used to configure this cookie.
Returns
Signature
public Craft\HttpCookie __construct ( $name, $value, $options = [] )