Andrew Nicols
61 lines
2.2 KiB
JavaScript
61 lines
2.2 KiB
JavaScript
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Simple API for set/get to sessionstorage, with cacherev expiration.
|
|
*
|
|
* Session storage will only persist for as long as the browser window
|
|
* stays open.
|
|
*
|
|
* See:
|
|
* https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage
|
|
*
|
|
* @module core/sessionstorage
|
|
* @copyright 2017 Ryan Wyllie <ryan@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
define(['core/config', 'core/storagewrapper'], function(config, StorageWrapper) {
|
|
|
|
// Private functions and variables.
|
|
/** @var {Object} StorageWrapper - Wraps browsers sessionStorage object */
|
|
var storage = new StorageWrapper(window.sessionStorage);
|
|
|
|
return /** @alias module:core/sessionstorage */ {
|
|
/**
|
|
* Get a value from session storage. Remember - all values must be strings.
|
|
*
|
|
* @method get
|
|
* @param {string} key The cache key to check.
|
|
* @return {boolean|string} False if the value is not in the cache, or some other error - a string otherwise.
|
|
*/
|
|
get: function(key) {
|
|
return storage.get(key);
|
|
},
|
|
|
|
/**
|
|
* Set a value to session storage. Remember - all values must be strings.
|
|
*
|
|
* @method set
|
|
* @param {string} key The cache key to set.
|
|
* @param {string} value The value to set.
|
|
* @return {boolean} False if the value can't be saved in the cache, or some other error - true otherwise.
|
|
*/
|
|
set: function(key, value) {
|
|
return storage.set(key, value);
|
|
}
|
|
|
|
};
|
|
});
|