класс ActionDispatch::Cookies

Родитель:: Объект

Файлы cookie читаются и записываются через ActionController#cookies.

Читаемые файлы cookie — это те, которые получены вместе с запросом, а записываемые файлы cookie будут отправлены вместе с ответом. Чтение файла cookie не возвращает сам объект cookie, а только значение, которое он содержит.

Примеры записи:

# Sets a simple session cookie.
# This cookie will be deleted when the user's browser is closed.
cookies[:user_name] = "david"

# Cookie values are String based. Other data types need to be serialized.
cookies[:lat_lon] = JSON.generate([47.68, -122.37])

# Sets a cookie that expires in 1 hour.
cookies[:login] = { value: "XJ-122", expires: 1.hour.from_now }

# Sets a signed cookie, which prevents users from tampering with its value.
# The cookie is signed by your app's `secrets.secret_key_base` value.
# It can be read using the signed method `cookies.signed[:name]`
cookies.signed[:user_id] = current_user.id

# Sets a "permanent" cookie (which expires in 20 years from now).
cookies.permanent[:login] = "XJ-122"

# You can also chain these methods:
cookies.permanent.signed[:login] = "XJ-122"

Примеры чтения:

cookies[:user_name]           # => "david"
cookies.size                  # => 2
JSON.parse(cookies[:lat_lon]) # => [47.68, -122.37]
cookies.signed[:login]        # => "XJ-122"

Пример удаления:

cookies.delete :user_name

Обратите внимание, что если при установке файла cookie вы указали :domain, вам также необходимо указать домен при удалении файла cookie:

cookies[:name] = {
  value: 'a yummy cookie',
  expires: 1.year.from_now,
  domain: 'domain.com'
}

cookies.delete(:name, domain: 'domain.com')

Символы опций для установки файлов cookie:

:value - Значение файла cookie.
:path - Путь, к которому применяется этот файл cookie. По умолчанию — корень приложения.
:domain - Домен, к которому применяется этот файл cookie, позволяя ограничить его на уровне домена. Если вы используете схему, например, www.example.com, и хотите обмениваться сессией с пользователем user.example.com, установите :domain на :all. Убедитесь, что вы указали опцию :domain с :all или Array при удалении файлов cookie.
```
domain: nil  # Does not sets cookie domain. (default)
domain: :all # Allow the cookie for the top most level
             # domain and subdomains.
domain: %w(.example.com .example.org) # Allow the cookie
                                      # for concrete domain names.
```
:expires - Время истечения срока действия этого файла cookie в качестве объекта Time.
:secure - Булево значение, указывающее, передаётся ли этот файл cookie только серверам HTTPS. По умолчанию false.
:httponly - Возможно ли использование этого файла cookie скриптами или только через HTTP. По умолчанию false.

Константы

COOKIES_DIGEST
COOKIES_SERIALIZER
CookieOverflow: Выбрасывается при хранении более 4 КБ данных сессии.
ENCRYPTED_COOKIE_SALT
ENCRYPTED_SIGNED_COOKIE_SALT
GENERATOR_KEY
HTTP_HEADER
MAX_COOKIE_SIZE: Файлы cookie обычно могут хранить 4096 байт.
SECRET_KEY_BASE
SECRET_TOKEN
SIGNED_COOKIE_SALT

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

new(app) Показать исходный код

# File actionpack/lib/action_dispatch/middleware/cookies.rb, line 555
def initialize(app)
  @app = app
end

Публичные методы экземпляра

call(env) Показать исходный код

# File actionpack/lib/action_dispatch/middleware/cookies.rb, line 559
def call(env)
  status, headers, body = @app.call(env)

  if cookie_jar = env['action_dispatch.cookies']
    unless cookie_jar.committed?
      cookie_jar.write(headers)
      if headers[HTTP_HEADER].respond_to?(:join)
        headers[HTTP_HEADER] = headers[HTTP_HEADER].join("\n")
      end
    end
  end

  [status, headers, body]
end