Fixing docblocks and minor test adjustments

This commit is contained in:
Dennis Eichhorn 2017-07-27 17:19:07 +02:00
parent d6034ce0c5
commit 9b40364e5e
55 changed files with 245 additions and 122 deletions

View File

@ -1,8 +1,7 @@
/**
* Form manager class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Account Manager.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Account type.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Particle class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Particle class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Particle animation class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Asset manager.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0
@ -38,6 +37,8 @@
const scripts = document.getElementsByTagName('script'),
length = !scripts ? 0 : scripts.length;
this.assets = {};
for (let i = 0; i < length; i++) {
this.assets[jsOMS.hash(scripts[i].src)] = scripts[i].src;
}
@ -121,7 +122,7 @@
/**
* Get asset.
*
* @param {string} id Id of the asset (hash)
* @param {string} key Key of the asset
*
* @return
*
@ -129,19 +130,21 @@
*
* @since 1.0.0
*/
jsOMS.Asset.AssetManager.prototype.get = function (id)
jsOMS.Asset.AssetManager.prototype.get = function (key)
{
if (this.assets[id]) {
return this.assets[id];
key = jsOMS.hash(key);
if (this.assets[key]) {
return this.assets[key];
}
return undefined;
return null;
};
/**
* Remove asset.
*
* @param {string} key Key of the asset (hash)
* @param {string} key Key of the asset
*
* @return {boolean}
*
@ -149,8 +152,10 @@
*
* @since 1.0.0
*/
jsOMS.Asset.AssetManager.prototype.remove = function (key)
jsOMS.Asset.AssetManager.prototype.remove = function (key, isHashed)
{
key = jsOMS.hash(key);
if (typeof this.assets[key] !== 'undefined') {
delete this.assets[key];

View File

@ -1,8 +1,7 @@
/**
* Auth class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,12 @@
/**
* Autoloader.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* The autoloader is responsible for defining namespaces and dynamically loading javascript
* files that are not yet included. The intention is to provide a similar functionality as
* include, import etc. Contrary to it's name the autoloader is not able to truely autoload
* referenced classes.
*
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,10 @@
/**
* Options class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* This is a generic options class for storing options. This is usefull for handling options in other modules
* without redefining the same behaviour multiple times.
*
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0
@ -39,7 +41,7 @@
*/
jsOMS.Config.Options.prototype.set = function (key, value, overwrite)
{
overwrite = typeof overwrite === bool ? overwrite : true;
overwrite = typeof overwrite === 'bool' ? overwrite : false;
if (overwrite || typeof this.options[key] === 'undefined') {
this.options[key] = value;
@ -67,7 +69,7 @@
return this.options[key];
}
return undefined;
return null;
};
/**

View File

View File

@ -1,8 +1,7 @@
/**
* CookieJar class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* LocalStorage class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -3,7 +3,6 @@
*
* Used for pooling requests.
*
* @author OMS Development Team <dev@oms.com>
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Log Level enum.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Logger class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Average class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Linear regression class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Browser notification.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Request data enum.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Request data enum.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Request class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Request data enum.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Http request method.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Request type enum.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -3,8 +3,7 @@
*
* Used for auto handling different responses.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -3,8 +3,7 @@
*
* Used for auto handling different responses.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Response result type enum.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Response type enum.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Module factory.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Module factory.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Cell.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Spreadsheet view.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Form manager class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0
@ -30,9 +29,11 @@
};
/**
* Bind button.
* Bind element.
*
* @param {string} [id] Button id (optional)
* @param {string} [id] Element id (optional)
*
* @return {void}
*
* @method
*
@ -51,9 +52,11 @@
};
/**
* Bind button.
* Bind element.
*
* @param {Element} e Button element
* @param {Element} e Element to bind
*
* @return {void}
*
* @method
*
@ -95,6 +98,18 @@
}
};
/**
* Bind listener for object
*
* @param {Element} e Element to bind
* @param {object} listener Listener object
*
* @return {void}
*
* @method
*
* @since 1.0.0
*/
jsOMS.UI.ActionManager.prototype.bindListener = function(e, listener)
{
const self = this,
@ -122,6 +137,8 @@
* @param {Element} e Button
* @param {Object} action Action
*
* @return {void}
*
* @method
*
* @since 1.0.0
@ -151,6 +168,8 @@
* @param {string} name Action identifier
* @param {function} callback Action callback
*
* @return {void}
*
* @method
*
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Form manager class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Form manager class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Form manager class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Tab manager class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Table manager class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Form manager class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Form manager class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Drag and drop class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* UI manager for handling basic ui elements.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* UI manager class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Keyboard manager class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Click type.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Event type.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Mouse manager class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* Touch manager class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,7 @@
/**
* UI manager for handling basic ui elements.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,9 @@
/**
* Form manager class.
* Unhandled Exception class.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* This class handles all unhandled exceptions depending on the configuration.
*
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0

View File

@ -1,8 +1,9 @@
/**
* Uri factory.
* Http Uri.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* This class is for creating, modifying and analysing http uris.
*
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0
@ -180,62 +181,172 @@
this.base = this.scheme + '://' + this.host + this.root;
};
/**
* Set root path.
*
* @param {string} rootPath Uri root path
*
* @return {void}
*
* @method
*
* @since 1.0.0
*/
jsOMS.Uri.Http.prototype.setRootPath = function(rootPath)
{
this.root = rootPath;
this.set(this.uri);
};
/**
* Get Uri base
*
* @return {string}
*
* @method
*
* @since 1.0.0
*/
jsOMS.Uri.Http.prototype.getBase = function()
{
return this.base;
};
/**
* Get Uri scheme
*
* @return {string}
*
* @method
*
* @since 1.0.0
*/
jsOMS.Uri.Http.prototype.getScheme = function()
{
return this.scheme;
};
/**
* Get Uri host
*
* @return {string}
*
* @method
*
* @since 1.0.0
*/
jsOMS.Uri.Http.prototype.getHost = function()
{
return this.host;
};
/**
* Get Uri port
*
* @return {string}
*
* @method
*
* @since 1.0.0
*/
jsOMS.Uri.Http.prototype.getPort = function()
{
return this.port;
};
/**
* Get Uri user
*
* @return {string}
*
* @method
*
* @since 1.0.0
*/
jsOMS.Uri.Http.prototype.getUser = function()
{
return this.user;
};
/**
* Get Uri pass
*
* @return {string}
*
* @method
*
* @since 1.0.0
*/
jsOMS.Uri.Http.prototype.getPass = function()
{
return this.pass;
};
/**
* Get Uri query
*
* @return {string}
*
* @method
*
* @since 1.0.0
*/
jsOMS.Uri.Http.prototype.getQuery = function()
{
return this.queryString;
};
/**
* Get Uri
*
* @return {string}
*
* @method
*
* @since 1.0.0
*/
jsOMS.Uri.Http.prototype.getUri = function()
{
return this.uri;
};
/**
* Get Uri fragment
*
* @return {string}
*
* @method
*
* @since 1.0.0
*/
jsOMS.Uri.Http.prototype.getFragment = function()
{
return this.fragment;
};
/**
* Get Uri path
*
* @return {string}
*
* @method
*
* @since 1.0.0
*/
jsOMS.Uri.Http.prototype.getPath = function()
{
return this.path;
};
/**
* Get Uri path offset
*
* @return {string}
*
* @method
*
* @since 1.0.0
*/
jsOMS.Uri.Http.prototype.getPathOffset = function()
{
return jsOMS.substr_count(this.root, '/') - 1;

View File

@ -1,8 +1,7 @@
/**
* Uri factory.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0
@ -48,6 +47,26 @@
return false;
};
/**
* Get query
*
* @param {string} key
*
* @return {string}|null
*
* @method
*
* @since 1.0.0
*/
jsOMS.Uri.UriFactory.getQuery = function (key)
{
if (!jsOMS.Uri.UriFactory.uri.hasOwnProperty(key)) {
return null;
}
return jsOMS.Uri.UriFactory.uri[key];
};
/**
* Clear all uri components
*

View File

@ -1,8 +1,11 @@
/**
* Core JS functionality
* Standard library
*
* This logic is supposed to minimize coding and support core javascript functionality.
* This library provides useful functionalities for the DOM and other manipulations.
*
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0
*/
(function (jsOMS)

View File

@ -1,8 +1,11 @@
/**
* Form view.
*
* @author OMS Development Team <dev@oms.com>
* @copyright 2013 Dennis Eichhorn
* The form view contains a single form and it's data elements. Form actions are no longer handled by
* the browser but through this view. The view also provides additional functionality for non-default
* form elements such as canvas etc.
*
* @copyright Dennis Eichhorn
* @license OMS License 1.0
* @version 1.0.0
* @since 1.0.0
@ -139,6 +142,7 @@
const selects = form.getElementsByTagName('select'),
textareas = form.getElementsByTagName('textarea'),
inputs = form.getElementsByTagName('input'),
canvas = form.getElementsByTagName('canvas'),
external = document.querySelectorAll('[form=' + this.id + ']');
return Array.prototype.slice.call(inputs).concat(Array.prototype.slice.call(selects), Array.prototype.slice.call(textareas), Array.prototype.slice.call(external));