Spec-Zone.ru › Yii 2.0

Класс yii\web\HeaderCollection

Все классы | Свойства | Методы
Наследование yii\web\HeaderCollection » yii\base\Object
Реализует ArrayAccess, Countable, IteratorAggregate, yii\base\Configurable
Доступно с версии 2.0
Исходный код https://github.com/yiisoft/yii2/blob/master/framework/web/HeaderCollection.php

HeaderCollection используется классом yii\web\Response для управления зарегистрированными HTTP-заголовками.

Открытые свойства

Свойство Тип Описание Определено в
$count целое число Количество заголовков в коллекции. yii\web\HeaderCollection
$iterator ArrayIterator Итератор для обхода заголовков в коллекции. yii\web\HeaderCollection

Открытые методы

Метод Описание Определено в
__call() Вызывает метод, который не является методом класса. yii\base\Object
__construct() Конструктор. yii\base\Object
__get() Возвращает значение свойства объекта. yii\base\Object
__isset() Проверяет, установлено ли свойство, т. е. определено и не равно null. yii\base\Object
__set() Устанавливает значение свойства объекта. yii\base\Object
__unset() Устанавливает свойство объекта в null. yii\base\Object
add() Добавляет новый заголовок. yii\web\HeaderCollection
canGetProperty() Возвращает значение, указывающее, можно ли считать свойство. yii\base\Object
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Object
className() Возвращает полное имя этого класса. yii\base\Object
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\Object
hasProperty() Возвращает значение, указывающее, определено ли свойство. yii\base\Object
init() Инициализирует объект. yii\base\Object
offsetExists() Возвращает значение, указывающее, существует ли заголовок с указанным именем. yii\web\HeaderCollection
offsetGet() Возвращает заголовок с указанным именем. yii\web\HeaderCollection
offsetSet() Добавляет заголовок в коллекцию. yii\web\HeaderCollection
offsetUnset() Удаляет заголовок с указанным именем. 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 getCount ( )

$iterator public только для чтения свойство

Итератор для обхода заголовков в коллекции.

public ArrayIterator getIterator ( )

Подробности методов

add() public method

Добавляет новый заголовок.

Если заголовок с таким же именем уже существует, новый заголовок будет добавлен к существующему, а не заменит его.

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

Имя заголовка

$value string

Значение заголовка

return $this

Объект коллекции

count() public method

Возвращает количество заголовков в коллекции.

Этот метод требуется интерфейсом SPL Countable. Он будет неявно вызываться при использовании count($collection).

public integer count ( )
return integer

Количество заголовков в коллекции.

fromArray() public method (доступно с версии 2.0.3)

Заполняет коллекцию заголовков из массива.

public void fromArray ( array $array )
$array array

Массив заголовков для заполнения

get() public method

Возвращает указанный(ые) заголовок(и).

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

Имя заголовка для возвращения

$default mixed

Значение, которое будет возвращено, если заголовок с указанным именем не найден

$first boolean

Возвращать только первый заголовок с указанным именем. Если false, будут возвращены все заголовки с указанным именем.

return string|array

Указанный(ые) заголовок(и). Если $first имеет значение true, будет возвращена строка; если $first имеет значение false, будет возвращён массив.

getCount() public method

Возвращает количество заголовков в коллекции.

public integer getCount ( )
return integer

Количество заголовков в коллекции.

getIterator() public method

Возвращает итератор для обхода заголовков в коллекции.

Этот метод требуется интерфейсом SPL IteratorAggregate. Он будет неявно вызываться при использовании foreach для обхода коллекции.

public ArrayIterator getIterator ( )
return ArrayIterator

Итератор для обхода заголовков в коллекции.

has() public method

Возвращает значение, указывающее, существует ли заголовок с указанным именем.

public boolean has ( $name )
$name string

Имя заголовка

return boolean

Существует ли заголовок с указанным именем

offsetExists() public method

Возвращает, существует ли заголовок с указанным именем.

Этот метод требуется интерфейсом SPL ArrayAccess. Он неявно вызывается при использовании чего-то вроде isset($collection[$name]).

public boolean offsetExists ( $name )
$name string

Имя заголовка

return boolean

Существует ли заголовок с указанным именем

offsetGet() public method

Возвращает заголовок с указанным именем.

Этот метод требуется интерфейсом SPL ArrayAccess. Он неявно вызывается при использовании чего-то вроде $header = $collection[$name];. Эквивалентно get().

public string offsetGet ( $name )
$name string

Имя заголовка

return string

Значение заголовка с указанным именем, null, если заголовок не существует.

offsetSet() public method

Добавляет заголовок в коллекцию.

Этот метод требуется интерфейсом SPL ArrayAccess. Он неявно вызывается при использовании чего-то вроде $collection[$name] = $header;. Эквивалентно add().

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

Имя заголовка

$value string

Значение добавляемого заголовка

offsetUnset() public method

Удаляет заголовок с указанным именем.

Этот метод требуется интерфейсом SPL ArrayAccess. Он неявно вызывается при использовании чего-то вроде unset($collection[$name]). Эквивалентно remove().

public void offsetUnset ( $name )
$name string

Имя заголовка

remove() public method

Удаляет заголовок.

public array remove ( $name )
$name string

Имя удаляемого заголовка.

return array

Значение удалённого заголовка. Null возвращается, если заголовок не существует.

removeAll() public method

Удаляет все заголовки.

public void removeAll ( )

set() public method

Добавляет новый заголовок.

Если заголовок с таким же именем уже существует, он будет заменён.

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

Имя заголовка

$value string

Значение заголовка

return $this

Объект коллекции

setDefault() public method

Устанавливает новый заголовок только в том случае, если он ещё не существует.

Если заголовок с таким же именем уже существует, новый будет проигнорирован.

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

Имя заголовка

$value string

Значение заголовка

return $this

Объект коллекции

toArray() public method

Возвращает коллекцию в виде массива PHP.

public array toArray ( )
возврат массив

Представление коллекции в виде массива. Ключи массива — имена заголовков, а значения — соответствующие значения заголовков.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-web-headercollection.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API