}
/**
* translate a string
- * @param app the id of the app for which to translate the string
- * @param text the string to translate
- * @param vars (optional) FIXME
- * @param count (optional) number to replace %n with
- * @return string
+ * @param {string} app the id of the app for which to translate the string
+ * @param {string} text the string to translate
+ * @param [vars] FIXME
+ * @param {number} [count] number to replace %n with
+ * @return {string}
*/
function t(app, text, vars, count){
initL10N(app);
/**
* translate a string
- * @param app the id of the app for which to translate the string
- * @param text_singular the string to translate for exactly one object
- * @param text_plural the string to translate for n objects
- * @param count number to determine whether to use singular or plural
- * @param vars (optional) FIXME
- * @return string
+ * @param {string} app the id of the app for which to translate the string
+ * @param {string} text_singular the string to translate for exactly one object
+ * @param {string} text_plural the string to translate for n objects
+ * @param {number} count number to determine whether to use singular or plural
+ * @param [vars] FIXME
+ * @return {string} Translated string
*/
function n(app, text_singular, text_plural, count, vars) {
initL10N(app);
}
/**
-* Sanitizes a HTML string
-* @param s string
-* @return Sanitized string
+* Sanitizes a HTML string by replacing all potential dangerous characters with HTML entities
+* @param {string} String to sanitize
+* @return {string} Sanitized string
*/
function escapeHTML(s) {
return s.toString().split('&').join('&').split('<').join('<').split('"').join('"');
/**
* Get the path to download a file
-* @param file The filename
-* @param dir The directory the file is in - e.g. $('#dir').val()
-* @return string
+* @param {string} file The filename
+* @param {string} dir The directory the file is in - e.g. $('#dir').val()
+* @return {string} Path to download the file
* @deprecated use Files.getDownloadURL() instead
*/
function fileDownloadPath(dir, file) {
appswebroots:(typeof oc_appswebroots !== 'undefined') ? oc_appswebroots:false,
currentUser:(typeof oc_current_user!=='undefined')?oc_current_user:false,
coreApps:['', 'admin','log','search','settings','core','3rdparty'],
+
/**
- * get an absolute url to a file in an appen
- * @param app the id of the app the file belongs to
- * @param file the file path relative to the app folder
- * @return string
+ * Get an absolute url to a file in an app
+ * @param {string} app the id of the app the file belongs to
+ * @param {string} file the file path relative to the app folder
+ * @return {string} Absolute URL to a file
*/
linkTo:function(app,file){
return OC.filePath(app,'',file);
},
+
/**
- * Creates an url for remote use
- * @param string $service id
- * @return string the url
- *
- * Returns a url to the given service.
+ * Creates a relative url for remote use
+ * @param {string} service id
+ * @return {string} the url
*/
linkToRemoteBase:function(service) {
return OC.webroot + '/remote.php/' + service;
},
+ /**
+ * @brief Creates an absolute url for remote use
+ * @param {string} service id
+ * @return {string} the url
+ */
+ linkToRemote:function(service) {
+ return window.location.protocol + '//' + window.location.host + OC.linkToRemoteBase(service);
+ },
+
/**
* Generates the absolute url for the given relative url, which can contain parameters.
- *
- * @returns {string}
- * @param {string} url
+ * @param {string} URL
* @param params
+ * @return {string} Absolute URL for the given relative URL
*/
generateUrl: function(url, params) {
var _build = function (text, vars) {
},
/**
- * @brief Creates an absolute url for remote use
- * @param string $service id
- * @param bool $add_slash
- * @return string the url
- *
- * Returns a absolute url to the given service.
- */
- linkToRemote:function(service) {
- return window.location.protocol + '//' + window.location.host + OC.linkToRemoteBase(service);
- },
- /**
- * get the absolute url for a file in an app
- * @param app the id of the app
- * @param type the type of the file to link to (e.g. css,img,ajax.template)
- * @param file the filename
- * @return string
+ * Get the absolute url for a file in an app
+ * @param {string} app the id of the app
+ * @param {string} type the type of the file to link to (e.g. css,img,ajax.template)
+ * @param {string} file the filename
+ * @return {string} Absolute URL for a file in an app
*/
filePath:function(app,type,file){
var isCore=OC.coreApps.indexOf(app)!==-1,
}
return link;
},
+
/**
* Redirect to the target URL, can also be used for downloads.
+ * @param {string} targetURL URL to redirect to
*/
redirect: function(targetUrl) {
window.location = targetUrl;
},
+
/**
* get the absolute path to an image file
- * @param app the app id to which the image belongs
- * @param file the name of the image file
- * @return string
- *
- * if no extension is given for the image, it will automatically decide between .png and .svg based on what the browser supports
+ * if no extension is given for the image, it will automatically decide
+ * between .png and .svg based on what the browser supports
+ * @param {string} app the app id to which the image belongs
+ * @param {string} file the name of the image file
+ * @return {string}
*/
imagePath:function(app,file){
if(file.indexOf('.')==-1){//if no extension is given, use png or svg depending on browser support
}
return OC.filePath(app,'img',file);
},
+
/**
- * load a script for the server and load it
- * @param app the app id to which the script belongs
- * @param script the filename of the script
+ * Load a script for the server and load it. If the script is already loaded,
+ * the event handeler will be called directly
+ * @param {string} app the app id to which the script belongs
+ * @param {string} script the filename of the script
* @param ready event handeler to be called when the script is loaded
- *
- * if the script is already loaded, the event handeler will be called directly
*/
addScript:function(app,script,ready){
var deferred, path=OC.filePath(app,'js',script+'.js');
return OC.addScript.loaded[path];
},
/**
- * load a css file and load it
- * @param app the app id to which the css style belongs
- * @param style the filename of the css file
+ * Loads a CSS file
+ * @param {string} app the app id to which the css style belongs
+ * @param {string} style the filename of the css file
*/
addStyle:function(app,style){
var path=OC.filePath(app,'css',style+'.css');
}
}
},
+
+ /**
+ * @todo Write the documentation
+ */
basename: function(path) {
return path.replace(/\\/g,'/').replace( /.*\//, '' );
},
+
+ /**
+ * @todo Write the documentation
+ */
dirname: function(path) {
return path.replace(/\\/g,'/').replace(/\/[^\/]*$/, '');
},
+
/**
- * do a search query and display the results
- * @param query the search query
+ * Do a search query and display the results
+ * @param {string} query the search query
*/
search:function(query){
if(query){
var date = new Date(1000*mtime);
return date.getDate()+'.'+(date.getMonth()+1)+'.'+date.getFullYear()+', '+date.getHours()+':'+date.getMinutes();
},
+
/**
* Parses a URL query string into a JS map
- * @param queryString query string in the format param1=1234¶m2=abcde¶m3=xyz
+ * @param {string} queryString query string in the format param1=1234¶m2=abcde¶m3=xyz
* @return map containing key/values matching the URL parameters
*/
parseQueryString:function(queryString){
/**
* Builds a URL query from a JS map.
* @param params parameter map
- * @return string containing a URL query (without question) mark
+ * @return {string} String containing a URL query (without question) mark
*/
buildQueryString: function(params) {
var s = '';
/**
* Opens a popup with the setting for an app.
- * @param appid String. The ID of the app e.g. 'calendar', 'contacts' or 'files'.
- * @param loadJS boolean or String. If true 'js/settings.js' is loaded. If it's a string
+ * @param {string} appid The ID of the app e.g. 'calendar', 'contacts' or 'files'.
+ * @param {boolean|string} loadJS If true 'js/settings.js' is loaded. If it's a string
* it will attempt to load a script by that name in the 'js' directory.
- * @param cache boolean. If true the javascript file won't be forced refreshed. Defaults to true.
- * @param scriptName String. The name of the PHP file to load. Defaults to 'settings.php' in
+ * @param {boolean} [cache] If true the javascript file won't be forced refreshed. Defaults to true.
+ * @param {string} [scriptName] The name of the PHP file to load. Defaults to 'settings.php' in
* the root of the app directory hierarchy.
*/
appSettings:function(args) {
}
},
- // for menu toggling
+ /**
+ * For menu toggeling
+ * @todo Write documentation
+ */
registerMenu: function($toggle, $menuEl) {
$menuEl.addClass('menu');
$toggle.addClass('menutoggle');
});
},
+ /**
+ * @todo Write documentation
+ */
unregisterMenu: function($toggle, $menuEl) {
// close menu if opened
if ($menuEl.is(OC._currentMenu)) {
*
* This is makes it possible for unit tests to
* stub matchMedia (which doesn't work in PhantomJS)
+ * @todo Write documentation
*/
_matchMedia: function(media) {
if (window.matchMedia) {
return false;
}
};
+
OC.search.customResults={};
OC.search.currentResult=-1;
OC.search.lastQuery='';
OC.addStyle.loaded=[];
OC.addScript.loaded=[];
+/**
+ * @todo Write documentation
+ */
OC.msg={
+ /**
+ * @param selector
+ * @todo Write documentation
+ */
startSaving:function(selector){
OC.msg.startAction(selector, t('core', 'Saving...'));
},
+
+ /**
+ * @param selector
+ * @param data
+ * @todo Write documentation
+ */
finishedSaving:function(selector, data){
OC.msg.finishedAction(selector, data);
},
+
+ /**
+ * @param selector
+ * @param {string} message Message to display
+ * @todo WRite documentation
+ */
startAction:function(selector, message){
$(selector)
.html( message )
.stop(true, true)
.show();
},
+
+ /**
+ * @param selector
+ * @param data
+ * @todo Write documentation
+ */
finishedAction:function(selector, data){
if( data.status === "success" ){
$(selector).html( data.data.message )
}
};
+/**
+ * @todo Write documentation
+ */
OC.Notification={
queuedNotifications: [],
getDefaultNotificationFunction: null,
+
+ /**
+ * @param callback
+ * @todo Write documentation
+ */
setDefault: function(callback) {
OC.Notification.getDefaultNotificationFunction = callback;
},
+
+ /**
+ * Hides a notification
+ * @param callback
+ * @todo Write documentation
+ */
hide: function(callback) {
$('#notification').fadeOut('400', function(){
if (OC.Notification.isHidden()) {
}
});
},
+
+ /**
+ * Shows a notification as HTML without being sanitized before.
+ * If you pass unsanitized userinput this may lead to a XSS vulnerability.
+ * Consider using show() instead of showHTML()
+ * @param {string} html Message to display
+ */
showHtml: function(html) {
if(($('#notification').filter('span.undo').length == 1) || OC.Notification.isHidden()){
$('#notification').html(html);
OC.Notification.queuedNotifications.push(html);
}
},
+
+ /**
+ * Shows a sanitized notification
+ * @param {string} text Message to display
+ */
show: function(text) {
if(($('#notification').filter('span.undo').length == 1) || OC.Notification.isHidden()){
$('#notification').text(text);
OC.Notification.queuedNotifications.push($('<div/>').text(text).html());
}
},
+
+ /**
+ * Returns whether a notification is hidden.
+ * @return {boolean}
+ */
isHidden: function() {
return ($("#notification").text() === '');
}
};
+/**
+ * @todo Write documentation
+ */
OC.Breadcrumb={
container:null,
+ /**
+ * @todo Write documentation
+ * @param dir
+ * @param leafname
+ * @param leaflink
+ */
show:function(dir, leafname, leaflink){
if(!this.container){//default
this.container=$('#controls');
this._push(container, leafname, leaflink);
}
},
+
+ /**
+ * @todo Write documentation
+ * @param {string} name
+ * @param {string} link
+ */
push:function(name, link){
if(!this.container){//default
this.container=$('#controls');
}
return crumb;
},
+
+ /**
+ * @todo Write documentation
+ */
pop:function(){
if(!this.container){//default
this.container=$('#controls');
this.container.find('div.crumb').last().remove();
this.container.find('div.crumb').last().addClass('last');
},
+
+ /**
+ * @todo Write documentation
+ */
clear:function(){
if(!this.container){//default
this.container=$('#controls');
};
if(typeof localStorage !=='undefined' && localStorage !== null){
- //user and instance aware localstorage
+ /**
+ * User and instance aware localstorage
+ */
OC.localStorage={
namespace:'oc_'+OC.currentUser+'_'+OC.webroot+'_',
+
+ /**
+ * Whether the storage contains items
+ * @param {string} name
+ * @return {boolean}
+ */
hasItem:function(name){
return OC.localStorage.getItem(name)!==null;
},
+
+ /**
+ * Add an item to the storage
+ * @param {string} name
+ * @param {string} item
+ */
setItem:function(name,item){
return localStorage.setItem(OC.localStorage.namespace+name,JSON.stringify(item));
},
+
+ /**
+ * Removes an item from the storage
+ * @param {string} name
+ * @param {string} item
+ */
removeItem:function(name,item){
return localStorage.removeItem(OC.localStorage.namespace+name);
},
+
+ /**
+ * Get an item from the storage
+ * @param {string} name
+ * @return {null|string}
+ */
getItem:function(name){
var item = localStorage.getItem(OC.localStorage.namespace+name);
- if(item===null) {
+ if(item === null) {
return null;
} else if (typeof JSON === 'undefined') {
//fallback to jquery for IE6/7/8
/**
* check if the browser support svg images
+ * @return {boolean}
*/
function SVGSupport() {
return SVGSupport.checkMimeType.correct && !!document.createElementNS && !!document.createElementNS('http://www.w3.org/2000/svg', "svg").createSVGRect;
};
SVGSupport.checkMimeType.correct=true;
-// replace all svg images with png for browser compatibility
-// @deprecated use OC.Util.replaceSVG instead
+/**
+ * Replace all svg images with png for browser compatibility
+ * @param $el
+ * @deprecated use OC.Util.replaceSVG instead
+ */
function replaceSVG($el){
return OC.Util.replaceSVG($el);
}
/**
* prototypal inharitence functions
- *
+ * @todo Write documentation
* usage:
* MySubObject=object(MyObject)
*/
/**
* Fills height of window. (more precise than height: 100%;)
+ * @param selector
*/
function fillHeight(selector) {
if (selector.length === 0) {
/**
* Fills height and width of window. (more precise than height: 100%; or width: 100%;)
+ * @param selector
*/
function fillWindow(selector) {
if (selector.length === 0) {
return this.filter(function() { return $(this).attr(attr_name) === attr_value; });
};
+/**
+ * Returns a human readable filesize
+ * @param {number} Size in bytes
+ * @return {string}
+ */
function humanFileSize(size) {
var humanList = ['B', 'kB', 'MB', 'GB', 'TB'];
// Calculate Log with base 1024: size = 1024 ** order
return relativeSize + ' ' + readableFormat;
}
+/**
+ * Format an UNIX timestamp to a human understandable format
+ * @param {number} date UNIX timestamp
+ * @return {string} Human readable format
+ */
function formatDate(date){
if(typeof date=='number'){
date=new Date(date);
return $.datepicker.formatDate(datepickerFormatDate, date)+' '+date.getHours()+':'+((date.getMinutes()<10)?'0':'')+date.getMinutes();
}
-// taken from http://stackoverflow.com/questions/1403888/get-url-parameter-with-jquery
+//
+/**
+ * Get the value of a URL parameter
+ * @link http://stackoverflow.com/questions/1403888/get-url-parameter-with-jquery
+ * @param {string} name URL parameter
+ * @return {string}
+ */
function getURLParameter(name) {
return decodeURI(
(RegExp(name + '=' + '(.+?)(&|$)').exec(location.search) || [, null])[1]
}
/**
- * takes an absolute timestamp and return a string with a human-friendly relative date
- * @param int a Unix timestamp
+ * Takes an absolute timestamp and return a string with a human-friendly relative date
+ * @param {number} A Unix timestamp
*/
function relative_modified_date(timestamp) {
var timediff = Math.round((new Date()).getTime() / 1000) - timestamp;
else { return t('core','years ago'); }
}
+/**
+ * @todo Write documentation
+ */
OC.Util = {
/**
* Returns whether the browser supports SVG
- *
- * @return true if the browser supports SVG, false otherwise
+ * @return {boolean} true if the browser supports SVG, false otherwise
*/
// TODO: replace with original function
hasSVGSupport: SVGSupport,
* If SVG is not supported, replaces the given icon's extension
* from ".svg" to ".png".
* If SVG is supported, return the image path as is.
- *
- * @param file image path with svg extension
- * @return fixed image path with png extension if SVG is not
- * supported
+ * @param {string} file image path with svg extension
+ * @return {string} fixed image path with png extension if SVG is not supported
*/
replaceSVGIcon: function(file) {
if (!OC.Util.hasSVGSupport()) {
};
/**
- * get a variable by name
- * @param string name
+ * Get a variable by name
+ * @param {string} name
+ * @return {*}
*/
OC.get=function(name) {
var namespaces = name.split(".");
};
/**
- * set a variable by name
- * @param string name
+ * Set a variable by name
+ * @param {string} name
* @param mixed value
*/
OC.set=function(name, value) {
jQuery.fn.exists = function(){
return this.length > 0;
};
-
projects / nextcloud-server.git / commitdiff