Overview

Namespaces

  • Composer
    • Autoload
  • Guzzle
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • QueryAggregator
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Mock
    • Stream
  • Mockery
    • Adapter
      • Phpunit
    • CountValidator
    • Exception
    • Generator
      • StringManipulation
        • Pass
    • Loader
    • Matcher
  • None
  • Omnipay
    • Common
      • Exception
      • Message
    • Dummy
      • Message
    • Fatzebra
      • Message
  • PHP
  • Symfony
    • Component
      • EventDispatcher
        • Debug
        • DependencyInjection
        • Tests
          • Debug
          • DependencyInjection
      • HttpFoundation
        • File
          • Exception
          • MimeType
        • Session
          • Attribute
          • Flash
          • Storage
            • Handler
            • Proxy
        • Tests
          • File
            • MimeType
          • Session
            • Attribute
            • Flash
            • Storage
              • Handler
              • Proxy
      • Yaml
        • Exception
        • Tests

Classes

  • AcceptHeader
  • AcceptHeaderItem
  • ApacheRequest
  • BinaryFileResponse
  • Cookie
  • ExpressionRequestMatcher
  • FileBag
  • HeaderBag
  • IpUtils
  • JsonResponse
  • ParameterBag
  • RedirectResponse
  • Request
  • RequestMatcher
  • RequestStack
  • Response
  • ResponseHeaderBag
  • ServerBag
  • StreamedResponse

Interfaces

  • RequestMatcherInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class Cookie

Represents a cookie.

Namespace: Symfony\Component\HttpFoundation
Author: Johannes M. Schmitt schmittjoh@gmail.com
Api
Located at Cookie.php
Methods summary
public
# __construct( string $name, string $value = null, integer|string|DateTime $expire = 0, string $path = '/', string $domain = null, boolean $secure = false, boolean $httpOnly = true )

Constructor.

Constructor.

Parameters

$name
The name of the cookie
$value
The value of the cookie
$expire
The time the cookie expires
$path
The path on the server in which the cookie will be available on
$domain
The domain that the cookie is available to
$secure
Whether the cookie should only be transmitted over a secure HTTPS connection from the client
$httpOnly
Whether the cookie will be made accessible only through the HTTP protocol

Throws

InvalidArgumentException

Api

public string
# __toString( )

Returns the cookie as a string.

Returns the cookie as a string.

Returns

string
The cookie
public string
# getName( )

Gets the name of the cookie.

Gets the name of the cookie.

Returns

string

Api

public string
# getValue( )

Gets the value of the cookie.

Gets the value of the cookie.

Returns

string

Api

public string
# getDomain( )

Gets the domain that the cookie is available to.

Gets the domain that the cookie is available to.

Returns

string

Api

public integer
# getExpiresTime( )

Gets the time the cookie expires.

Gets the time the cookie expires.

Returns

integer

Api

public string
# getPath( )

Gets the path on the server in which the cookie will be available on.

Gets the path on the server in which the cookie will be available on.

Returns

string

Api

public boolean
# isSecure( )

Checks whether the cookie should only be transmitted over a secure HTTPS connection from the client.

Checks whether the cookie should only be transmitted over a secure HTTPS connection from the client.

Returns

boolean

Api

public boolean
# isHttpOnly( )

Checks whether the cookie will be made accessible only through the HTTP protocol.

Checks whether the cookie will be made accessible only through the HTTP protocol.

Returns

boolean

Api

public boolean
# isCleared( )

Whether this cookie is about to be cleared.

Whether this cookie is about to be cleared.

Returns

boolean

Api

Properties summary
protected $name
#
protected $value
#
protected $domain
#
protected $expire
#
protected $path
#
protected $secure
#
protected $httpOnly
#
Omnipay Fat Zebra / Paystream Gateway Module API Documentation API documentation generated by ApiGen