Класс yii\web\Cookie
| Наследование | yii\web\Cookie » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/web/Cookie.php |
Cookie представляет информацию, связанную с куки, такую как $name, $value, $domain и т. д.
Для получения более подробной информации и инструкций по использованию Cookie, см. статью руководства по работе с куки.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $domain | строка | Домен куки | yii\web\Cookie |
| $expire | целое число | Отметка времени истечения срока действия куки. Это серверная отметка времени. По умолчанию 0, что означает "до закрытия браузера". | yii\web\Cookie |
| $httpOnly | булево значение | Доступна ли куки только через HTTP-протокол. Установка этого свойства в значение true делает куки недоступной для скриптовых языков, таких как JavaScript, что может эффективно снизить риск кражи данных через атаки XSS. | yii\web\Cookie |
| $name | строка | Имя куки | yii\web\Cookie |
| $path | строка | Путь на сервере, где доступна куки. По умолчанию — '/'. | yii\web\Cookie |
| $secure | булево значение | Нужно ли отправлять куки через защищенное соединение | yii\web\Cookie |
| $value | строка | Значение куки | yii\web\Cookie |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод с указанным именем, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, задано ли свойство (определено и не равно null). | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __toString() | Магический метод для преобразования объекта куки в строку без явного доступа к $value. | yii\web\Cookie |
| __unset() | Устанавливает свойство объекта в значение null. | yii\base\Object |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
Подробности свойств
$domain общедоступное свойство
Домен куки
public string $domain = ''
$expire общедоступное свойство
Отметка времени истечения срока действия куки. Это серверная отметка времени. По умолчанию 0, что означает "до закрытия браузера".
public integer $expire = 0
$httpOnly общедоступное свойство
Доступна ли куки только через HTTP-протокол. Установка этого свойства в значение true делает куки недоступной для скриптовых языков, таких как JavaScript, что может эффективно снизить риск кражи данных через атаки XSS.
public boolean $httpOnly = true
$name общедоступное свойство
Имя куки
public string $name = null
$path общедоступное свойство
Путь на сервере, где доступна куки. По умолчанию — '/'.
public string $path = '/'
$secure общедоступное свойство
Нужно ли отправлять куки через защищенное соединение
public boolean $secure = false
$value общедоступное свойство
Значение куки
public string $value = ''
Подробности методов
__toString() общедоступный метод
Магический метод для преобразования объекта куки в строку без явного доступа к $value.
if (isset($request->cookies['name'])) {
$value = (string) $request->cookies['name'];
}
| общедоступная строка __toString ( ) | ||
|---|---|---|
| возвращает | строка |
Значение куки. Если свойство value равно null, возвращается пустая строка. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-web-cookie.html
