Module: Outpost::Controller::Preferences

Extended by:
ActiveSupport::Concern
Defined in:
lib/outpost/controller/preferences.rb

Instance Method Summary collapse

Instance Method Details

#preference(key) ⇒ Object

Public: Getter for preference. Preferences are stored in the browser’s session on a per-resource basis.

key - (String) The key for the preference.

Examples

preference("posts_order")
# => "updated_at"

Returns String of the requested preference.



22
23
24
# File 'lib/outpost/controller/preferences.rb', line 22

def preference(key)
  session["preference_#{key}"]
end

#set_preference(key, value) ⇒ Object

Public: Writer for preference.

key - (String) The key to write to. value - (String) The value of the preference.

Examples

set_preference("posts_order", "updated_at")
preference("posts_order")
# => "updated_at"

Returns nothing.



38
39
40
# File 'lib/outpost/controller/preferences.rb', line 38

def set_preference(key, value)
  session["preference_#{key}"] = value
end

#unset_preference(key) ⇒ Object

Public: Unset a preference.

key - (String) The key to delete from preferences.

Examples

unset_preference("posts_order")
preference("posts_order")
# => nil

Returns nothing.



53
54
55
# File 'lib/outpost/controller/preferences.rb', line 53

def unset_preference(key)
  set_preference(key, nil)
end