HttpCookie

Type
Class
Namespace
Craft
Inherits
Craft\HttpCookie » CHttpCookie » CComponent
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

Public Properties

PropertyDescription
$domainstring – Domain of the cookie
$expireinteger – The timestamp at which the cookie expires.
$httpOnlyboolean – Whether the cookie should be accessible only through the HTTP protocol.
$namestring – Name of the cookie
$pathstring – The path on the server in which the cookie will be available on.
$secureboolean – Whether cookie should be sent via secure connection
$valuestring – Value of the cookie

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Creates a new HttpCookie instance.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__toString()Magic method to use the cookie object as a string without having to call value property first.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
configure()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()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()Evaluates a PHP expression or callback under the context of this component.
getEventHandlers()Returns the list of attached event handlers for an event.
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
raiseEvent()Raises an event.

__construct()

Creates a new HttpCookie instance.

View source

Arguments

  • $name (string) – The name of this cookie.
  • $value (string) – The cookie's value.
  • $options (array) – The configuration array consisting of name-value pairs that are used to configure this cookie.

Returns

Craft\HttpCookie

Signature

public Craft\HttpCookie __construct ( $name, $value, $options = [] )