Spec-Zone.ru › Yii 2.0

Класс yii\web\CookieCollection

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

CookieCollection сохраняет доступные cookie в текущем запросе.

Для получения более подробной информации и руководства по использованию CookieCollection, см. статью руководства по обработке cookie.

Публичные свойства

Свойство Тип Описание Определено в
$count целое число Количество cookie в коллекции. yii\web\CookieCollection
$iterator ArrayIterator Итератор для обхода cookie в коллекции. yii\web\CookieCollection
$readOnly boolean Является ли эта коллекция только для чтения. yii\web\CookieCollection

Публичные методы

Метод Описание Определено в
__call() Вызывает метод с указанным именем, который не является методом класса. yii\base\Object
__construct() Конструктор. yii\web\CookieCollection
__get() Возвращает значение свойства объекта. yii\base\Object
__isset() Проверяет, задано ли свойство, т.е. определено и не равно null. yii\base\Object
__set() Устанавливает значение свойства объекта. yii\base\Object
__unset() Устанавливает свойство объекта в null. yii\base\Object
add() Добавляет cookie в коллекцию. yii\web\CookieCollection
canGetProperty() Возвращает значение, указывающее, можно ли считать свойство. yii\base\Object
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Object
className() Возвращает полное имя этого класса. yii\base\Object
count() Возвращает количество cookie в коллекции. yii\web\CookieCollection
fromArray() Заполняет коллекцию cookie из массива. yii\web\CookieCollection
get() Возвращает cookie с указанным именем. yii\web\CookieCollection
getCount() Возвращает количество cookie в коллекции. yii\web\CookieCollection
getIterator() Возвращает итератор для обхода cookie в коллекции. yii\web\CookieCollection
getValue() Возвращает значение cookie с указанным именем. yii\web\CookieCollection
has() Возвращает, существует ли cookie с указанным именем. yii\web\CookieCollection
hasMethod() Возвращает значение, указывающее, определен ли метод. yii\base\Object
hasProperty() Возвращает значение, указывающее, определено ли свойство. yii\base\Object
init() Инициализирует объект. yii\base\Object
offsetExists() Возвращает, существует ли cookie с указанным именем. yii\web\CookieCollection
offsetGet() Возвращает cookie с указанным именем. yii\web\CookieCollection
offsetSet() Добавляет cookie в коллекцию. yii\web\CookieCollection
offsetUnset() Удаляет cookie с указанным именем. yii\web\CookieCollection
remove() Удаляет cookie. yii\web\CookieCollection
removeAll() Удаляет все cookie. yii\web\CookieCollection
toArray() Возвращает коллекцию в виде массива PHP. yii\web\CookieCollection

Подробности свойств

$count публичное только для чтения свойство

Количество cookie в коллекции.

public integer getCount ( )

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

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

public ArrayIterator getIterator ( )

$readOnly публичное свойство

Является ли эта коллекция только для чтения.

public boolean $readOnly = false

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

__construct() public method

Конструктор.

public void __construct ( $cookies = [], $config = [] )
$cookies массив

Куки, которые изначально содержатся в этой коллекции. Это должен быть массив пар имя-значение.

$config массив

Пары имя-значение, которые будут использованы для инициализации свойств объекта

add() public method

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

Если в коллекции уже есть куки с тем же именем, он будет сначала удален.

public void add ( $cookie )
$cookie yii\web\Cookie

Добавляемый куки

throws yii\base\InvalidCallException

если коллекция куки только для чтения

count() public method

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

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

public целое число count ( )
return целое число

Количество куки в коллекции.

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

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

public void fromArray ( массив $array )
$array массив

Куки для заполнения

get() public method

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

См. также getValue().

public yii\web\Cookie get ( $name )
$name строка

Имя куки

return yii\web\Cookie

Куки с указанным именем. Null, если куки с указанным именем не существует.

getCount() public method

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

public целое число getCount ( )
return целое число

Количество куки в коллекции.

getIterator() public method

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

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

public ArrayIterator getIterator ( )
return ArrayIterator

Итератор для перебора куки в коллекции.

getValue() public method

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

См. также get().

public mixed getValue ( $name, $defaultValue = null )
$name строка

Имя куки

$defaultValue смешанный тип

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

return смешанный тип

Значение куки с указанным именем.

has() public method

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

Обратите внимание, что если куки отмечен для удаления из браузера, этот метод вернёт false.

См. также remove().

public логическое значение has ( $name )
$name строка

Имя куки

return логическое значение

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

offsetExists() public method

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

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

public логическое значение offsetExists ( $name )
$name строка

Имя куки

return логическое значение

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

offsetGet() public method

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

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

public yii\web\Cookie offsetGet ( $name )
$name строка

Имя куки

return yii\web\Cookie

Куки с указанным именем, null, если куки с указанным именем не существует.

offsetSet() public method

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

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

public void offsetSet ( $name, $cookie )
$name строка

Имя куки

$cookie yii\web\Cookie

Добавляемый куки

offsetUnset() public method

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

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

public void offsetUnset ( $name )
$name строка

Имя куки

remove() public method

Удаляет куки.

Если $removeFromBrowser равно true, куки будет удален из браузера. В этом случае в коллекцию будет добавлен куки с устаревшим сроком действия.

public void remove ( $cookie, $removeFromBrowser = true )
$cookie yii\web\Cookie|строка

Объект куки или имя куки, который нужно удалить.

$removeFromBrowser логическое значение

Удалить куки из браузера

throws yii\base\InvalidCallException

если коллекция куки только для чтения

removeAll() public method

Удаляет все куки.

public void removeAll ( )
throws yii\base\InvalidCallException

если коллекция куки только для чтения

toArray() public method

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

public массив toArray ( )
return массив

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

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

Spec-Zone.ru

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