PHP Class Symfony\Component\HttpFoundation\Cookie

Author: Johannes M. Schmitt ([email protected])
ファイルを表示 Open project: symfony/symfony Class Usage Examples

Protected Properties

Property Type Description
$domain
$expire
$httpOnly
$name
$path
$secure
$value

Public Methods

Method Description
__construct ( string $name, string | null $value = null, integer | string | DateTimeInterface $expire, string $path = '/', string | null $domain = null, boolean $secure = false, boolean $httpOnly = true, boolean $raw = false, string | null $sameSite = null ) Constructor.
__toString ( ) : string Returns the cookie as a string.
fromString ( string $cookie, boolean $decode = false ) : static Creates cookie from raw header string.
getDomain ( ) : string | null Gets the domain that the cookie is available to.
getExpiresTime ( ) : integer Gets the time the cookie expires.
getMaxAge ( ) : integer Gets the max-age attribute.
getName ( ) : string Gets the name of the cookie.
getPath ( ) : string Gets the path on the server in which the cookie will be available on.
getSameSite ( ) : string | null Gets the SameSite attribute.
getValue ( ) : string | null Gets the value of the cookie.
isCleared ( ) : boolean Whether this cookie is about to be cleared.
isHttpOnly ( ) : boolean Checks whether the cookie will be made accessible only through the HTTP protocol.
isRaw ( ) : boolean Checks if the cookie value should be sent with no url encoding.
isSecure ( ) : boolean Checks whether the cookie should only be transmitted over a secure HTTPS connection from the client.

Method Details

__construct() public method

Constructor.
public __construct ( string $name, string | null $value = null, integer | string | DateTimeInterface $expire, string $path = '/', string | null $domain = null, boolean $secure = false, boolean $httpOnly = true, boolean $raw = false, string | null $sameSite = null )
$name string The name of the cookie
$value string | null The value of the cookie
$expire integer | string | DateTimeInterface The time the cookie expires
$path string The path on the server in which the cookie will be available on
$domain string | null The domain that the cookie is available to
$secure boolean Whether the cookie should only be transmitted over a secure HTTPS connection from the client
$httpOnly boolean Whether the cookie will be made accessible only through the HTTP protocol
$raw boolean Whether the cookie value should be sent with no url encoding
$sameSite string | null Whether the cookie will be available for cross-site requests

__toString() public method

Returns the cookie as a string.
public __toString ( ) : string
return string The cookie

fromString() public static method

Creates cookie from raw header string.
public static fromString ( string $cookie, boolean $decode = false ) : static
$cookie string
$decode boolean
return static

getDomain() public method

Gets the domain that the cookie is available to.
public getDomain ( ) : string | null
return string | null

getExpiresTime() public method

Gets the time the cookie expires.
public getExpiresTime ( ) : integer
return integer

getMaxAge() public method

Gets the max-age attribute.
public getMaxAge ( ) : integer
return integer

getName() public method

Gets the name of the cookie.
public getName ( ) : string
return string

getPath() public method

Gets the path on the server in which the cookie will be available on.
public getPath ( ) : string
return string

getSameSite() public method

Gets the SameSite attribute.
public getSameSite ( ) : string | null
return string | null

getValue() public method

Gets the value of the cookie.
public getValue ( ) : string | null
return string | null

isCleared() public method

Whether this cookie is about to be cleared.
public isCleared ( ) : boolean
return boolean

isHttpOnly() public method

Checks whether the cookie will be made accessible only through the HTTP protocol.
public isHttpOnly ( ) : boolean
return boolean

isRaw() public method

Checks if the cookie value should be sent with no url encoding.
public isRaw ( ) : boolean
return boolean

isSecure() public method

Checks whether the cookie should only be transmitted over a secure HTTPS connection from the client.
public isSecure ( ) : boolean
return boolean

Property Details

$domain protected_oe property

protected $domain

$expire protected_oe property

protected $expire

$httpOnly protected_oe property

protected $httpOnly

$name protected_oe property

protected $name

$path protected_oe property

protected $path

$secure protected_oe property

protected $secure

$value protected_oe property

protected $value