Spec-Zone.ru › CakePHP 3.4

Интерфейс CookieInterface

Интерфейс Cookie

Прямые реализаторы

  • Cake\Http\Cookie\Cookie
Пространство имён: Cake\Http\Cookie
Расположение: Http/Cookie/CookieInterface.php

Краткое описание констант

  • string

    EXPIRES_FORMAT
    'D, d-M-Y H:i:s T'

Краткое описание методов

  • getDomain() public
    Получить атрибут домена.
  • getExpiresTimestamp() public
    Получить отметку времени окончания срока действия
  • getExpiry() public
    Получить текущее время истечения срока действия
  • getFormattedExpires() public
    Создаёт значение срока действия для строки заголовка
  • getId() public
    Получить идентификатор куки
  • getName() public
    Получить имя куки
  • getPath() public
    Получить атрибут пути.
  • getValue() public
    Получить значение куки
  • isExpired() public
    Проверить, истекло ли время действия куки по сравнению с $time
  • isHttpOnly() public
    Проверить, является ли кука HTTP-только
  • isSecure() public
    Проверить, является ли кука защищённой
  • toHeaderValue() public
    Возвращает значение куки в формате заголовка
  • withDomain() public
    Создаёт куки с обновлённым доменом
  • withExpired() public
    Создаёт новую куки, которая истечёт/будет удалена из браузера.
  • withExpiry() public
    Создаёт куки с обновлённой датой истечения срока действия
  • withHttpOnly() public
    Создаёт куки с обновлённым атрибутом HTTP-только
  • withName() public
    Устанавливает имя куки
  • withNeverExpire() public
    Создаёт новую куки, которая фактически никогда не истечёт.
  • withPath() public
    Создаёт новую куки с обновлённым путём
  • withSecure() public
    Создаёт куки с обновлённым атрибутом защищённости
  • withValue() public
    Создаёт куки с обновлённым значением.

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

getDomain()source public

getDomain( )

Получить атрибут домена.

Возвращает

строка

getExpiresTimestamp()source public

getExpiresTimestamp( )

Получить отметку времени окончания срока действия

Отметки времени являются строками, так как большие отметки времени могут переполнить MAX_INT в 32-битных системах.

Возвращает

строка|null
Время истечения срока действия в виде строковой отметки времени.

getExpiry()source public

getExpiry( )

Получить текущее время истечения срока действия

Возвращает

DateTime|DateTimeImmutable|null
Отметка времени истечения срока действия или null

getFormattedExpires()source public

getFormattedExpires( )

Создаёт значение срока действия для строки заголовка

Возвращает

строка

getId()source public

getId( )

Получить идентификатор куки

Куки уникальны в кортежах имя, домен, путь.

Возвращает

строка

getName()source public

getName( )

Получить имя куки

Возвращает

строка

getPath()source public

getPath( )

Получить атрибут пути.

Возвращает

строка

getValue()source public

getValue( )

Получить значение куки

Возвращает

строка|массив

isExpired()source public

isExpired( DateTime|DateTimeImmutable $time null )

Проверить, истекло ли время действия куки по сравнению с $time

Куки без даты истечения срока действия всегда возвращают false.

Параметры

DateTime|DateTimeImmutable $time опционально null
Время для проверки. По умолчанию - текущее время в UTC.

Возвращает

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

isHttpOnly()source public

isHttpOnly( )

Проверить, является ли кука HTTP-только

Возвращает

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

isSecure()source public

isSecure( )

Проверить, является ли кука защищённой

Возвращает

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

toHeaderValue()source public

toHeaderValue( )

Возвращает значение куки в формате заголовка

Возвращает

строка

withDomain()source public

withDomain( string $domain )

Создаёт куки с обновлённым доменом

Параметры

строка $domain
Домен для установки

Возвращает

Cake\Http\Cookie\CookieInterface

withExpired()source public

withExpired( )

Создаёт новую куки, которая истечёт/будет удалена из браузера.

Это делается путём установки времени истечения на 1 год назад

Возвращает

Cake\Http\Cookie\CookieInterface

withExpiry()source public

withExpiry( DateTime|DateTimeImmutable $dateTime )

Создаёт куки с обновлённой датой истечения срока действия

Параметры

DateTime|DateTimeImmutable $dateTime
Объект даты и времени

Возвращает

Cake\Http\Cookie\CookieInterface
END_OF_DOCUMENT_MARKER

withHttpOnly()source public

withHttpOnly( boolean $httpOnly )

Создать cookie с обновленным HTTP Only

Параметры

boolean $httpOnly
HTTP Only

Возвращает

Cake\Http\Cookie\CookieInterface

withName()source public

withName( string $name )

Устанавливает имя cookie

Параметры

string $name
Имя cookie

Возвращает

Cake\Http\Cookie\CookieInterface

withNeverExpire()source public

withNeverExpire( )

Создать новый cookie, который практически никогда не истечёт.

Возвращает

Cake\Http\Cookie\CookieInterface

withPath()source public

withPath( string $path )

Создать новый cookie с обновлённым путем

Параметры

string $path
Устанавливает путь

Возвращает

Cake\Http\Cookie\CookieInterface

withSecure()source public

withSecure( boolean $secure )

Создать cookie с обновленным Secure

Параметры

boolean $secure
Значение атрибута Secure

Возвращает

Cake\Http\Cookie\CookieInterface

withValue()source public

withValue( string|array $value )

Создать cookie с обновленным значением.

Параметры

string|array $value
Значение cookie для установки

Возвращает

Cake\Http\Cookie\CookieInterface

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.4/class-Cake.Http.Cookie.CookieInterface.html

Spec-Zone.ru

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