Overview

Namespaces

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

Classes

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

Class SetCookie

Set-Cookie ヘッダーを表現するクラスです.

Peach\Http\Header\SetCookie implements Peach\Http\MultiHeaderField
Namespace: Peach\Http\Header
Located at Peach/Http/Header/SetCookie.php
Methods summary
public
# __construct( string $name = null, string $value = null, Peach\Http\Header\CookieOptions $options = null )

新しい SetCookie オブジェクトを構築します. 引数に cookie のキー, 値, 属性を指定することで, 初期化と同時に 1 個目の cookie を追加することができます. 引数を省略した場合は cookie を何も持たない状態で初期化されます.

新しい SetCookie オブジェクトを構築します. 引数に cookie のキー, 値, 属性を指定することで, 初期化と同時に 1 個目の cookie を追加することができます. 引数を省略した場合は cookie を何も持たない状態で初期化されます.

Parameters

$name
cookie のキー
$value
cookie の値
$options
各種属性
public
# setItem( string $name, string $value, Peach\Http\Header\CookieOptions $options = null )

指定されたキーと値の cookie を持つ新しい Set-Cookie ヘッダーを追加します.

指定されたキーと値の cookie を持つ新しい Set-Cookie ヘッダーを追加します.

Parameters

$name
cookie のキー
$value
cookie の値
$options
各種属性
public array
# format( )

すべての Set-Cookie ヘッダーの値を配列で返します.

すべての Set-Cookie ヘッダーの値を配列で返します.

Returns

array
すべての Set-Cookie ヘッダー値の配列

Implementation of

Peach\Http\MultiHeaderField::format()
public string
# getName( )

文字列 "set-cookie" を返します.

文字列 "set-cookie" を返します.

Returns

string
ヘッダー名 "set-cookie"

Implementation of

Peach\Http\HeaderField::getName()
public Peach\Http\Header\CookieItem[]
# getValues( )

このオブジェクトにセットされている Set-Cookie ヘッダーの一覧を CookieItem オブジェクトの配列として返します.

このオブジェクトにセットされている Set-Cookie ヘッダーの一覧を CookieItem オブジェクトの配列として返します.

Returns

Peach\Http\Header\CookieItem[]
CookieItem オブジェクトの配列

Implementation of

Peach\Http\MultiHeaderField::getValues()
PEACH2 API documentation generated by ApiGen