Http/Header/SetCookie.php
Show:
inherited
inherited
Classes
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Http
- Subpackage
- Header
- Version
- $Id$
\Zend_Http_Header_SetCookie
Package: Zend_Http\Header
Returns
Zend_Http_Client is an implementation of an HTTP client in PHP. The client
supports basic features like sending different HTTP requests and handling
redirections, as well as more advanced features like proxy settings, HTTP
authentication and cookie persistence (using a Zend_Http_CookieJar object)
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Todo
- Implement proxy settings
Properties
string $domain = nullCookie domain
Default value
nullDetails- Type
- string
int $expires = nullCookie expiry date
Default value
nullDetails- Type
- int
true $httponly = nullDefault value
nullDetails- Type
- true
integer $maxAge = nullMax Age
Default value
nullDetails- Type
- integer
string $name = nullCookie name
Default value
nullDetails- Type
- string
string $path = nullCookie path
Default value
nullDetails- Type
- string
boolean $secure = nullWhether the cookie is secure or not
Default value
nullDetails- Type
- boolean
string $value = nullCookie value
Default value
nullDetails- Type
- string
integer $version = nullVersion
Default value
nullDetails- Type
- integer
Methods
__construct(string $name = null, string $value = null, int $expires = null, string $path = null, string $domain = null, bool $secure = false, bool $httponly = false, string $maxAge = null, int $version = null) : \SetCookieCookie object constructor
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | string | |
| $expires | int | |
| $path | string | |
| $domain | string | |
| $secure | bool | |
| $httponly | bool | |
| $maxAge | string | |
| $version | int |
| Type | Description |
|---|---|
| \SetCookie |
- Todo
- Add validation of each one of the parameters (legal domain, etc.)
__toString() : voidfromString( $headerLine, bool $bypassHeaderFieldName = false) : array | \SetCookiestatic
Generate a new Cookie object from a cookie string (for example the value of the Set-Cookie HTTP header)
Parameters
Returns
Throws
Details
| Name | Type | Description |
|---|---|---|
| $headerLine | ||
| $bypassHeaderFieldName | bool |
| Type | Description |
|---|---|
| array | \SetCookie |
| Exception | Description |
|---|---|
| \Zend_Http_Header_Exception_InvalidArgumentException |
- Static
getDomain() : stringReturns
| Type | Description |
|---|---|
| string |
getExpires( $inSeconds = false) : intParameters
Returns
| Name | Type | Description |
|---|---|---|
| $inSeconds |
| Type | Description |
|---|---|
| int |
getFieldName() : stringReturns
| Type | Description |
|---|---|
| string | 'Set-Cookie' |
getFieldValue() : stringReturns
Throws
| Type | Description |
|---|---|
| string |
| Exception | Description |
|---|---|
| \Zend_Http_Header_Exception_RuntimeException |
getMaxAge() : integerGet Max-Age
Returns
| Type | Description |
|---|---|
| integer |
getName() : stringReturns
| Type | Description |
|---|---|
| string |
getPath() : stringReturns
| Type | Description |
|---|---|
| string |
getValue() : stringReturns
| Type | Description |
|---|---|
| string |
getVersion() : integerGet version
Returns
| Type | Description |
|---|---|
| integer |
isExpired(int $now = null) : booleanCheck whether the cookie has expired
Always returns false if the cookie is a session cookie (has no expiry time)
Parameters| Name | Type | Description |
|---|---|---|
| $now | int | Timestamp to consider as "now" |
| Type | Description |
|---|---|
| boolean |
isHttponly() : boolReturns
| Type | Description |
|---|---|
| bool |
isSecure() : booleanReturns
| Type | Description |
|---|---|
| boolean |
isSessionCookie() : booleanCheck whether the cookie is a session cookie (has no expiry time set)
Returns
| Type | Description |
|---|---|
| boolean |
isValidForRequest( $requestDomain, $path, $isSecure = false) : voidParameters
| Name | Type | Description |
|---|---|---|
| $requestDomain | ||
| $path | ||
| $isSecure |
setDomain(string $domain) : voidParameters
| Name | Type | Description |
|---|---|---|
| $domain | string |
setExpires(int $expires) : \SetCookieParameters
Returns
| Name | Type | Description |
|---|---|---|
| $expires | int |
| Type | Description |
|---|---|
| \SetCookie |
setHttponly(bool $httponly) : voidParameters
| Name | Type | Description |
|---|---|---|
| $httponly | bool |
setMaxAge(integer $maxAge) : voidSet Max-Age
Parameters
| Name | Type | Description |
|---|---|---|
| $maxAge | integer |
setName(string $name) : \SetCookieParameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| \SetCookie |
setPath(string $path) : voidParameters
| Name | Type | Description |
|---|---|---|
| $path | string |
setSecure(boolean $secure) : voidParameters
| Name | Type | Description |
|---|---|---|
| $secure | boolean |
setValue(string $value) : voidParameters
| Name | Type | Description |
|---|---|---|
| $value | string |
setVersion(integer $version) : voidSet version
Parameters
| Name | Type | Description |
|---|---|---|
| $version | integer |
toString() : voidtoStringMultipleHeaders( $headers) : voidParameters
| Name | Type | Description |
|---|---|---|
| $headers |