Class yii\web\HeaderCollection

继承yii\web\HeaderCollection » yii\base\BaseObject
实现ArrayAccess, Countable, IteratorAggregate, yii\base\Configurable
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/web/HeaderCollection.php

yii\web\Response 使用 HeaderCollection 来维护当前注册的 HTTP 标头.

公共属性

隐藏继承的属性

属性类型描述定义在
$count integer 集合中标头的数量. 该属性是只读的. yii\web\HeaderCollection
$iterator ArrayIterator 一个遍历集合中标头的迭代器. 该属性是只读的. yii\web\HeaderCollection

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的已命名方法. yii\base\BaseObject
__construct() 构造函数. yii\base\BaseObject
__get() 返回对象属性的值. yii\base\BaseObject
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\BaseObject
__set() 设置对象属性的值. yii\base\BaseObject
__unset() 将对象属性设置为null. yii\base\BaseObject
add() 添加一个新的标头. yii\web\HeaderCollection
canGetProperty() 返回一个值, 指示属性是否可读. yii\base\BaseObject
canSetProperty() 返回一个值, 指示属性是否可写. yii\base\BaseObject
className() 返回此类的完全限定名称. yii\base\BaseObject
count() 返回集合中标头的数量. yii\web\HeaderCollection
fromArray() 从数组中填充标头集合. yii\web\HeaderCollection
get() 返回指定的标头. yii\web\HeaderCollection
getCount() 返回集合中标头的数量. yii\web\HeaderCollection
getIterator() 返回遍历集合中标头的迭代器. yii\web\HeaderCollection
has() 返回一个值, 指示指定的标头是否存在. yii\web\HeaderCollection
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\BaseObject
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\BaseObject
init() 初始化对象. yii\base\BaseObject
offsetExists() 返回是否存在具有指定名称的标头. yii\web\HeaderCollection
offsetGet() 返回具有指定名称的标头. yii\web\HeaderCollection
offsetSet() 将标头添加到集合中. yii\web\HeaderCollection
offsetUnset() Removes the named header. yii\web\HeaderCollection
remove() 删除标头. yii\web\HeaderCollection
removeAll() 删除所有标头. yii\web\HeaderCollection
set() 添加一个新的标头. yii\web\HeaderCollection
setDefault() 仅在新标头不存在的情况下才设置它. yii\web\HeaderCollection
toArray() 将集合作为 PHP 数组返回. yii\web\HeaderCollection

属性详情

$count public 属性

集合中标头的数量. 该属性是只读的.

public integer $count null
$iterator public 属性

一个遍历集合中标头的迭代器. 该属性是只读的.

public ArrayIterator $iterator null

方法详情

add() public 方法

添加一个新的标头.

如果已经有一个名称相同的标头, 则将新标头附加到该标头上, 而不是替换它.

public $this add ( $name, $value )
$name string

标头的名称.

$value string

标头的值.

return $this

集合对象本身.

count() public 方法

返回集合中标头的数量.

SPL Countable 接口需要此方法. 当你使用count($collection)时, 它会被隐式调用.

public integer count ( )
return integer

集合中标头的数量.

fromArray() public 方法 (可用自版本: 2.0.3)

从数组中填充标头集合.

public void fromArray ( array $array )
$array array

要填充的标头.

get() public 方法

返回指定的标头.

public string|array get ( $name, $default null, $first true )
$name string

要返回的标头的名称.

$default mixed

在指定的标头不存在的情况下返回的值.

$first boolean

是否仅返回指定名称的第一个标头. 如果为false, 则返回指定名称的所有标头.

return string|array

指定的标头. 如果$firsttrue, 则返回一个字符串. 如果$firstfalse, 则返回一个数组.

getCount() public 方法

返回集合中标头的数量.

public integer getCount ( )
return integer

集合中标头的数量.

getIterator() public 方法

返回遍历集合中标头的迭代器.

SPL 接口 IteratorAggregate 需要此方法. 当你使用foreach遍历集合时, 它会被隐式调用.

public ArrayIterator getIterator ( )
return ArrayIterator

一个遍历集合中标头的迭代器.

has() public 方法

返回一个值, 指示指定的标头是否存在.

public boolean has ( $name )
$name string

标头的名称.

return boolean

指定标头是否存在.

offsetExists() public 方法

返回是否存在具有指定名称的标头.

SPL 接口 ArrayAccess 需要此方法. 当你使用诸如isset($collection[$name])的时候, 它被隐式调用.

public boolean offsetExists ( $name )
$name string

标头名称.

return boolean

是否存在指定的标头.

offsetGet() public 方法

返回具有指定名称的标头.

SPL 接口 ArrayAccess 需要此方法. 当你使用诸如$header = $collection[$name];的时候, 它被隐式调用. 这相当于 get().

public string offsetGet ( $name )
$name string

标头名称.

return string

具有指定名称的标头值; 如果指定的标头不存在, 则返回null.

offsetSet() public 方法

将标头添加到集合中.

SPL 接口 ArrayAccess 需要此方法. 当你使用诸如$collection[$name] = $header;的时候, 它被隐式调用. 这相当于 add().

public void offsetSet ( $name, $value )
$name string

标头名称.

$value string

要添加的标头值.

offsetUnset() public 方法

Removes the named header.

SPL 接口 ArrayAccess 需要此方法. 当你使用诸如unset($collection[$name])的时候, 它被隐式调用. 这相当于 remove().

public void offsetUnset ( $name )
$name string

标头名称.

remove() public 方法

删除标头.

public array remove ( $name )
$name string

要删除的标头的名称.

return array

已删除的标头的值. 如果标头不存在, 则返回null.

removeAll() public 方法

删除所有标头.

public void removeAll ( )
set() public 方法

添加一个新的标头.

如果已经有一个同名的标头, 它将被替换.

public $this set ( $name, $value '' )
$name string

标头的名称.

$value string

标头的值.

return $this

集合对象本身.

setDefault() public 方法

仅在新标头不存在的情况下才设置它.

如果已经有一个名称相同的标头, 则新标头将被忽略.

public $this setDefault ( $name, $value )
$name string

标头的名称.

$value string

标头的值.

return $this

集合对象本身.

toArray() public 方法

将集合作为 PHP 数组返回.

public array toArray ( )
return array

集合的数组表示形式. 数组键是标头名称, 数组值是相应的标头值.