/**
* Function that's useful when constructing the URI string -- we frequently encounter the pattern of
* having to add something to the URI as we go, but only if it's present, and to include a character before or after if so.
- * @param {String} to prepend, if value not empty
- * @param {String} value to include, if not empty
- * @param {String} to append, if value not empty
- * @param {Boolean} raw -- if true, do not URI encode
- * @return {String}
+ * @param {string|undefined} pre To prepend.
+ * @param {string} val To include.
+ * @param {string} post To append.
+ * @param {boolean} raw If true, val will not be encoded.
+ * @return {string} Result.
*/
function cat( pre, val, post, raw ) {
if ( val === undefined || val === null || val === '' ) {
/**
* Constructs URI object. Throws error if arguments are illegal/impossible, or otherwise don't parse.
* @constructor
- * @param {Object|String} URI string, or an Object with appropriate properties (especially another URI object to clone).
+ * @param {Object|string} uri URI string, or an Object with appropriate properties (especially another URI object to clone).
* Object must have non-blank 'protocol', 'host', and 'path' properties.
- * This parameter is optional. If omitted (or set to undefined, null or empty string), then an object will be created
- * for the default uri of this constructor (e.g. document.location for mw.Uri in MediaWiki core).
- * @param {Object|Boolean} Object with options, or (backwards compatibility) a boolean for strictMode
- * - strictMode {Boolean} Trigger strict mode parsing of the url. Default: false
- * - overrideKeys {Boolean} Wether to let duplicate query parameters override eachother (true) or automagically
- * convert to an array (false, default).
+ * This parameter is optional. If omitted (or set to undefined, null or empty string), then an object will be created
+ * for the default uri of this constructor (e.g. document.location for mw.Uri in MediaWiki core).
+ * @param {Object|boolean} Object with options, or (backwards compatibility) a boolean for strictMode
+ * - {boolean} strictMode Trigger strict mode parsing of the url. Default: false
+ * - {boolean} overrideKeys Wether to let duplicate query parameters override eachother (true) or automagically
+ * convert to an array (false, default).
*/
function Uri( uri, options ) {
options = typeof options === 'object' ? options : { strictMode: !!options };
}
if ( this.path && this.path.charAt( 0 ) !== '/' ) {
// A real relative URL, relative to defaultUri.path. We can't really handle that since we cannot
- // figure out whether the last path compoennt of defaultUri.path is a directory or a file.
+ // figure out whether the last path component of defaultUri.path is a directory or a file.
throw new Error( 'Bad constructor arguments' );
}
if ( !( this.protocol && this.host && this.path ) ) {
/**
* Standard encodeURIComponent, with extra stuff to make all browsers work similarly and more compliant with RFC 3986
* Similar to rawurlencode from PHP and our JS library mw.util.rawurlencode, but we also replace space with a +
- * @param {String} string
- * @return {String} encoded for URI
+ * @param {string} s String to encode.
+ * @return {string} Encoded string for URI.
*/
Uri.encode = function ( s ) {
return encodeURIComponent( s )
};
/**
- * Standard decodeURIComponent, with '+' to space
- * @param {String} string encoded for URI
- * @return {String} decoded string
+ * Standard decodeURIComponent, with '+' to space.
+ * @param {string} s String encoded for URI.
+ * @return {string} Decoded string.
*/
Uri.decode = function ( s ) {
return decodeURIComponent( s.replace( /\+/g, '%20' ) );
/**
* Parse a string and set our properties accordingly.
- * @param {String} URI
+ * @param {string} str URI
* @param {Object} options
- * @return {Boolean} success
+ * @return {boolean} Success.
*/
parse: function ( str, options ) {
var q,
/**
* Returns user and password portion of a URI.
- * @return {String}
+ * @return {string}
*/
getUserInfo: function () {
return cat( '', this.user, cat( ':', this.password, '' ) );
/**
* Gets host and port portion of a URI.
- * @return {String}
+ * @return {string}
*/
getHostPort: function () {
return this.host + cat( ':', this.port, '' );
/**
* Returns the userInfo and host and port portion of the URI.
* In most real-world URLs, this is simply the hostname, but it is more general.
- * @return {String}
+ * @return {string}
*/
getAuthority: function () {
return cat( '', this.getUserInfo(), '@' ) + this.getHostPort();
/**
* Returns the query arguments of the URL, encoded into a string
* Does not preserve the order of arguments passed into the URI. Does handle escaping.
- * @return {String}
+ * @return {string}
*/
getQueryString: function () {
var args = [];
/**
* Returns everything after the authority section of the URI
- * @return {String}
+ * @return {string}
*/
getRelativePath: function () {
return this.path + cat( '?', this.getQueryString(), '', true ) + cat( '#', this.fragment, '' );
/**
* Gets the entire URI string. May not be precisely the same as input due to order of query arguments.
- * @return {String} the URI string
+ * @return {string} The URI string.
*/
toString: function () {
return this.protocol + '://' + this.getAuthority() + this.getRelativePath();
dépôts / lhc / web / wiklou.git / commitdiff