Plugins/Hash.Cookie.js

   1 /*\r
   2 Script: Hash.Cookie.js\r
   3         Stores and loads an Hash as a cookie using Json format.\r
   4 */\r
   5 \r
   6 /*\r
   7 Class: Hash.Cookie\r
   8         Inherits all the methods from <Hash>, additional methods are save and load.\r
   9         Hash json string has a limit of 4kb (4096byte), so be careful with your Hash size.\r
  10         Creating a new instance automatically loads the data from the Cookie into the Hash.\r
  11         If the Hash is emptied, the cookie is also removed.\r
  12 \r
  13 Arguments:\r
  14         name - the key (name) for the cookie\r
  15         options - options are identical to <Cookie> and are simply passed along to it.\r
  16                 In addition, it has the autoSave option, to save the cookie at every operation. defaults to true.\r
  17 \r
  18 Example:\r
  19         (start code)\r
  20         var fruits = new Hash.Cookie('myCookieName', {duration: 3600});\r
  21         fruits.extend({\r
  22                 'lemon': 'yellow',\r
  23                 'apple': 'red'\r
  24         });\r
  25         fruits.set('melon', 'green');\r
  26         fruits.get('lemon'); // yellow\r
  27 \r
  28         // ... on another page ... values load automatically\r
  29 \r
  30         var fruits = new Hash.Cookie('myCookieName', {duration: 365});\r
  31         fruits.get('melon'); // green\r
  32 \r
  33         fruits.erase(); // delete cookie\r
  34         (end)\r
  35 */\r
  36 \r
  37 Hash.Cookie = Hash.extend({\r
  38 \r
  39         initialize: function(name, options){\r
  40                 this.name = name;\r
  41                 this.options = $extend({'autoSave': true}, options || {});\r
  42                 this.load();\r
  43         },\r
  44 \r
  45         /*\r
  46         Property: save\r
  47                 Saves the Hash to the cookie. If the hash is empty, removes the cookie.\r
  48 \r
  49         Returns:\r
  50                 Returns false when the JSON string cookie is too long (4kb), otherwise true.\r
  51 \r
  52         Example:\r
  53                 (start code)\r
  54                 var login = new Hash.Cookie('userstatus', {autoSave: false});\r
  55 \r
  56                 login.extend({\r
  57                         'username': 'John',\r
  58                         'credentials': [4, 7, 9]\r
  59                 });\r
  60                 login.set('last_message', 'User logged in!');\r
  61 \r
  62                 login.save(); // finally save the Hash\r
  63                 (end)\r
  64         */\r
  65 \r
  66         save: function(){\r
  67                 if (this.length == 0){\r
  68                         Cookie.remove(this.name, this.options);\r
  69                         return true;\r
  70                 }\r
  71                 var str = Json.toString(this.obj);\r
  72                 if (str.length > 4096) return false; //cookie would be truncated!\r
  73                 Cookie.set(this.name, str, this.options);\r
  74                 return true;\r
  75         },\r
  76         \r
  77         /*\r
  78         Property: load\r
  79                 Loads the cookie and assigns it to the Hash.\r
  80         */\r
  81 \r
  82         load: function(){\r
  83                 this.obj = Json.evaluate(Cookie.get(this.name), true) || {};\r
  84                 this.setLength();\r
  85         }\r
  86 \r
  87 });\r
  88 \r
  89 Hash.Cookie.Methods = {};\r
  90 ['extend', 'set', 'merge', 'empty', 'remove'].each(function(method){\r
  91         Hash.Cookie.Methods[method] = function(){\r
  92                 Hash.prototype[method].apply(this, arguments);\r
  93                 if (this.options.autoSave) this.save();\r
  94                 return this;\r
  95         };\r
  96 });\r
  97 Hash.Cookie.implement(Hash.Cookie.Methods);