Overview

Namespaces

  • Peach
    • DF
    • DT
    • Http
      • Body
      • Header
    • Markup
    • Util

Classes

  • CookieItem
  • CookieOptions
  • HttpDate
  • NoField
  • QualityValues
  • Raw
  • SetCookie
  • Status
  • Overview
  • Namespace
  • Class

Class CookieOptions

Set-Cookie ヘッダーの各種属性をあらわすクラスです. このクラスのオブジェクトに対する変更は, 関連するすべての CookieItem オブジェクトに影響を与えます.

Namespace: Peach\Http\Header
Located at Peach/Http/Header/CookieOptions.php
Methods summary
public
# __construct( )

属性を何も持たない, 新しい CookieOptions オブジェクトを構築します.

属性を何も持たない, 新しい CookieOptions オブジェクトを構築します.

public
# setExpires( Peach\DT\Timestamp $expires = null )

expires 属性の時刻を設定します. 引数に null を設定した場合は expires 属性を削除します.

expires 属性の時刻を設定します. 引数に null を設定した場合は expires 属性を削除します.

Parameters

$expires
Set-Cookie の expires 属性として表現される時刻
public Peach\DT\Timestamp
# getExpires( )

expires 属性の時刻を返します. expires 属性が設定されていない場合は null を返します.

expires 属性の時刻を返します. expires 属性が設定されていない場合は null を返します.

Returns

Peach\DT\Timestamp
expires 属性の時刻
public
# setTimeZoneOffset( integer $offset )

このオブジェクトが取り扱う Timestamp オブジェクトの時差を分単位でセットします. このメソッドは expires 属性の出力に影響します. PHP の date.timezone 設定がシステムの時差と異なる場合に使用してください. 通常はこのメソッドを使用する必要はありません.

このオブジェクトが取り扱う Timestamp オブジェクトの時差を分単位でセットします. このメソッドは expires 属性の出力に影響します. PHP の date.timezone 設定がシステムの時差と異なる場合に使用してください. 通常はこのメソッドを使用する必要はありません.

もしも引数に -23:45 (1425) 以上または +23:45 (-1425) 未満の値を指定した場合は -23:45 または +23:45 に丸めた結果を返します.

Parameters

$offset
時差

See

Util::cleanTimeZoneOffset()
public integer
# getTimeZoneOffset( )

このオブジェクトが取り扱う Timestamp オブジェクトの時差を返します. このメソッドはデフォルトで null を返します.

このオブジェクトが取り扱う Timestamp オブジェクトの時差を返します. このメソッドはデフォルトで null を返します.

Returns

integer
時差. ただしデフォルトの場合は null
public
# setMaxAge( integer $maxAge )

max-age 属性の値をセットします. 引数に 0 をセットした場合は対象の Cookie がブラウザから削除されます. 引数が 0 未満の値の場合は 0 として扱われます.

max-age 属性の値をセットします. 引数に 0 をセットした場合は対象の Cookie がブラウザから削除されます. 引数が 0 未満の値の場合は 0 として扱われます.

Parameters

$maxAge
max-age 属性の値
public integer
# getMaxAge( )

max-age 属性の値を返します. もしも max-age 属性がセットされていない場合は null を返します.

max-age 属性の値を返します. もしも max-age 属性がセットされていない場合は null を返します.

Returns

integer
max-age 属性の値. セットされていない場合は null
public
# setDomain( string $domain )

domain 属性の値をセットします. 引数に null をセットした場合は domain 属性を削除します.

domain 属性の値をセットします. 引数に null をセットした場合は domain 属性を削除します.

Parameters

$domain
domain 属性の値
public string
# getDomain( )

domain 属性の値を返します. domain 属性がセットされていない場合は null を返します.

domain 属性の値を返します. domain 属性がセットされていない場合は null を返します.

Returns

string
public
# setPath( string $path )

path 属性の値をセットします. 引数に null をセットした場合は path 属性を削除します.

path 属性の値をセットします. 引数に null をセットした場合は path 属性を削除します.

Parameters

$path
public string
# getPath( )

path 属性の値を返します. もしも path 属性がセットされていない場合は null を返します.

path 属性の値を返します. もしも path 属性がセットされていない場合は null を返します.

Returns

string
path 属性の値. セットされていない場合は null
public
# setSecure( boolean $secure )

secure 属性をセットします. もしも引数が true の場合は secure 属性を有効化, false の場合は無効化します.

secure 属性をセットします. もしも引数が true の場合は secure 属性を有効化, false の場合は無効化します.

Parameters

$secure
secure 属性を有効化する場合は true, 無効化する場合は false
public boolean
# hasSecure( )

secure 属性が有効かどうかを判定します. secure 属性が有効な場合は true, そうでない場合は false を返します. もしもこのオブジェクトの setSecure() を一度も実行していない場合, secure 属性は無効となるため false を返します.

secure 属性が有効かどうかを判定します. secure 属性が有効な場合は true, そうでない場合は false を返します. もしもこのオブジェクトの setSecure() を一度も実行していない場合, secure 属性は無効となるため false を返します.

Returns

boolean
secure 属性が有効な場合は true, そうでない場合は false
public
# setHttpOnly( boolean $httpOnly )

httponly 属性をセットします. もしも引数が true の場合は httponly 属性を有効化, false の場合は無効化します.

httponly 属性をセットします. もしも引数が true の場合は httponly 属性を有効化, false の場合は無効化します.

Parameters

$httpOnly
httponly 属性を有効化する場合は true, 無効化する場合は false
public boolean
# hasHttpOnly( )

httponly 属性が有効かどうかを判定します. httponly 属性が有効な場合は true, そうでない場合は false を返します. もしもこのオブジェクトの setHttpOnly() を一度も実行していない場合, httponly 属性は無効となるため false を返します.

httponly 属性が有効かどうかを判定します. httponly 属性が有効な場合は true, そうでない場合は false を返します. もしもこのオブジェクトの setHttpOnly() を一度も実行していない場合, httponly 属性は無効となるため false を返します.

Returns

boolean
httponly 属性が有効な場合は true, そうでない場合は false
PEACH2 API documentation generated by ApiGen