egroupware_official/api/js/jsapi/egw_store.js
2022-04-05 10:24:06 +02:00

121 lines
2.9 KiB
JavaScript

/**
* EGroupware clientside API for persistant storage
*
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @package etemplate
* @subpackage api
* @link http://www.egroupware.org
* @author Nathan Gray
* @version $Id$
*/
/*egw:uses
egw_core;
egw_ready;
egw_debug;
*/
import './egw_core.js';
/**
* Store is a wrapper around browser based, persistant storage.
*
*
* @see http://www.w3.org/TR/webstorage/#storage
*
* @param {string} _app
* @param {DOMWindow} _wnd
*/
egw.extend('store', egw.MODULE_GLOBAL, function(_app, _wnd)
{
"use strict";
var egw = this;
/**
* Since the storage is shared across at least all applications, make
* the key include some extra info.
*
* @param {string} application
* @param {string} key
* @returns {undefined}
*/
function mapKey(application, key)
{
return application + '-' + key;
}
return {
/**
* Retrieve a value from session storage
*
* @param {string} application Name of application, or common
* @param {string} key
* @returns {string}
*/
getSessionItem: function(application, key) {
key = mapKey(application, key);
return _wnd.sessionStorage.getItem(key);
},
/**
* Set a value in session storage
*
* @param {string} application Name of application, or common
* @param {string} key
* @param {string} value
* @returns {@exp;window@pro;sessionStorage@call;setItem}
*/
setSessionItem: function(application, key, value) {
key = mapKey(application, key);
return _wnd.sessionStorage.setItem(key, value);
},
/**
* Remove a value from session storage
* @param {string} application
* @param {string} key
* @returns {@exp;window@pro;sessionStorage@call;removeItem}
*/
removeSessionItem: function(application, key) {
key = mapKey(application, key);
return _wnd.sessionStorage.removeItem(key);
},
/**
* Set an item to localStorage
*
* @param {string} application an application name or a prefix
* @param {string} item
* @param {any} value
* @returns {undefined} returns undefined
*/
setLocalStorageItem: function(application, item, value){
item = mapKey (application, item);
return localStorage.setItem(item,value);
},
/**
* Get an item from localStorage
*
* @param {string} application an application name or prefix
* @param {stirng} item an item name stored in localStorage
* @return {string|null} reutrns requested item value otherwise null
*/
getLocalStorageItem: function(application, item){
item = mapKey(application, item);
return localStorage.getItem(item);
},
/**
* Remove an item from localStorage
*
* @param {string} application application name or prefix
* @param {string} item an item name to remove
* @return {undefined} returns undefined
*/
removeLocalStorageItem: function (application, item){
item = mapKey(application, item);
return localStorage.removeItem(item);
}
};
});