Classes Files Search

Classes

Hierarchy

Class $k.NewCookie

Represents a new HTTP Cookie (RFC 2109) that can be added to a response

Class Summary
Constructor Attributes Constructor Name and Description
 
$k.NewCookie(name, value)
Creates a new cookie

Method Summary

Class Detail

$k.NewCookie(name, value)
Creates a new cookie
Parameters:
{string} name
{string} value

Method Detail

  • {string} comment()
    Returns the comment of the cookie
    Returns:
    {string}
  • {string} domain()
    Returns the domain of the cookie
    Returns:
    {string}
  • {date} expiry()
    Returns the expiry date of the cookie
    Returns:
    {date}
  • {boolean} httpOnly()
    Returns true if the cookie contains the HttpOnly attribute
    Returns:
    {boolean}
  • {number} maxAge()
    Returns the maximum age of the the cookie in seconds
    Returns:
    {number}
  • {string} path()
    Returns the path of the cookie
    Returns:
    {string}
  • {number} port()
    Returns the port of the cookie
    Returns:
    {number}
  • {boolean} secureOnly()
    Returns true if the cookie will only be sent over a secure connection
    Returns:
    {boolean}
  • setComment(comment)
    Sets the comment of the cookie
    Parameters:
    {string} comment
  • setDomain(domain)
    Sets the domain of the cookie
    Parameters:
    {string} domain
  • setExpiry(expiryDate)
    Sets the expiry date of the cookie
    Parameters:
    {date} expiryDate
  • setHttpOnly(httpOnly)
    Set the HttpOnly attribute
    Parameters:
    {boolean} httpOnly Optional
    True if undefined
  • setMaxAge(maxAge)
    Sets the maximum age of the the cookie in seconds
    Parameters:
    {number} maxAge
  • setPath(path)
    Sets the path of the cookie
    Parameters:
    {string} path
  • setPort(port)
    Sets the port of the cookie
    Parameters:
    {number} port
  • setSecureOnly(secureOnly)
    Set if the cookie will only be sent over a secure connection
    Parameters:
    {boolean} secureOnly Optional
    True if undefined
  • setVersion(version)
    Sets the version of the cookie
    Parameters:
    {number} version
  • {number} version()
    Returns the version of the cookie
    Returns:
    {number}