CHttpCookie
| Пакет | system.web |
|---|---|
| Наследование | класс CHttpCookie » CComponent |
| С версии | 1.0 |
| Исходный код | framework/web/CHttpCookie.php |
Свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| домен | строка | домен cookie | CHttpCookie |
| срок действия | целое число | отметка времени истечения срока действия cookie. Это серверное время. По умолчанию 0, что означает "до закрытия браузера". | CHttpCookie |
| httpOnly | булево | указывает, должен ли cookie быть доступен только через протокол HTTP. Установив это свойство в true, cookie не будет доступен скриптовым языкам, таким как JavaScript, что может эффективно снизить кражу идентификационных данных через XSS-атаки. Обратите внимание, что это свойство работает только для PHP 5.2.0 или выше. | CHttpCookie |
| имя | строка | имя cookie | CHttpCookie |
| путь | строка | путь на сервере, на котором cookie будет доступен. По умолчанию '/'. | CHttpCookie |
| защищённый | булево | указывает, должен ли cookie отправляться по защищённому соединению | CHttpCookie |
| значение | строка | значение cookie | CHttpCookie |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод, который не является методом класса. | CComponent |
| __construct() | Конструктор. | CHttpCookie |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства null. | CComponent |
| __set() | Устанавливает значение свойства компонента. | CComponent |
| __toString() | Магический метод для использования объекта cookie как строки без предварительного вызова свойства value. | CHttpCookie |
| __unset() | Устанавливает свойство компонента в null. | CComponent |
| asa() | Возвращает объект поведения по имени. | CComponent |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | CComponent |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | CComponent |
| attachEventHandler() | Прикрепляет обработчик событий к событию. | CComponent |
| canGetProperty() | Определяет, можно ли прочитать свойство. | CComponent |
| canSetProperty() | Определяет, можно ли установить свойство. | CComponent |
| configure() | Этот метод может быть использован для конфигурации объекта Cookie с массивом. | CHttpCookie |
| detachBehavior() | Отсоединяет поведение от компонента. | CComponent |
| detachBehaviors() | Отсоединяет все поведения от компонента. | CComponent |
| detachEventHandler() | Отсоединяет существующий обработчик событий. | CComponent |
| disableBehavior() | Отключает присоединённое поведение. | CComponent |
| disableBehaviors() | Отключает все присоединённые к этому компоненту поведения. | CComponent |
| enableBehavior() | Включает присоединённое поведение. | CComponent |
| enableBehaviors() | Включает все присоединённые к этому компоненту поведения. | CComponent |
| evaluateExpression() | Вычисляет выражение PHP или обратный вызов в контексте этого компонента. | CComponent |
| getEventHandlers() | Возвращает список присоединённых обработчиков событий для события. | CComponent |
| hasEvent() | Определяет, определено ли событие. | CComponent |
| hasEventHandler() | Проверяет, есть ли прикреплённые обработчики к указанному событию. | CComponent |
| hasProperty() | Определяет, определено ли свойство. | CComponent |
| raiseEvent() | Вызывает событие. | CComponent |
Подробное описание свойств
домен свойство
public string $domain;
домен cookie
срок действия свойство
public integer $expire;
отметка времени истечения срока действия cookie. Это серверное время. По умолчанию 0, что означает "до закрытия браузера".
httpOnly свойство
public boolean $httpOnly;
указывает, должен ли cookie быть доступен только через протокол HTTP. Установив это свойство в true, cookie не будет доступен скриптовым языкам, таким как JavaScript, что может эффективно снизить кражу идентификационных данных через XSS-атаки. Обратите внимание, что это свойство работает только для PHP 5.2.0 или выше.
имя свойство
public string $name;
имя cookie
путь свойство
public string $path;
путь на сервере, на котором cookie будет доступен. По умолчанию '/'.
защищённый свойство
public boolean $secure;
указывает, должен ли cookie отправляться по защищённому соединению
значение свойство
public string $value;
значение cookie
Подробное описание методов
__construct() метод
public void __construct(string $name, string $value, array $options=array ( )) | ||
| $name | строка | имя cookie |
| $value | строка | значение cookie |
| $options | массив | массив конфигурации, состоящий из пар "имя-значение", используемых для конфигурации этого cookie |
public function __construct($name,$value,$options=array())
{
$this->name=$name;
$this->value=$value;
$this->configure($options);
}
Конструктор.
__toString() метод (доступен с версии 1.1.11)
public string __toString() | ||
| {возвращает} | строка | Значение cookie. Если свойство value равно null, возвращается пустая строка. |
public function __toString()
{
return (string)$this->value;
}
Магический метод для использования объекта cookie как строки без предварительного вызова свойства value.
$value = (string)$cookies['name'];
Обратите внимание, что вам все равно необходимо проверить, существует ли cookie.
configure() метод (доступен с версии 1.1.11)
public void configure(array $options=array ( )) | ||
| $options | массив | массив конфигурации, состоящий из пар имя-значение, которые используются для настройки этого куки |
public function configure($options=array())
{
foreach($options as $name=>$value)
{
if($name==='name'||$name==='value')
continue;
$this->$name=$value;
}
}
Этот метод можно использовать для настройки объекта Cookie с помощью массива. Примечание: с помощью этого метода нельзя задавать имя и/или значение куки.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CHttpCookie