Helpers when working with parseParams

[Udo Borkowski]

I found the following two helper functions very useful when working with the named parameter feature (i.e. the stuff around the "parseParams" function).

// Returns the first value of the given named parameter.
//
// @param params
//         as returned by parseParams or null/undefined
//
function getParamValue(params, name, defaultValue) {
    if (!params)
        return defaultValue;
       
    var p = params[0][name];
    return (!p || p.length == 0) ? defaultValue : p[0];
}

// Returns the first value of the given boolean named parameter.
//
// @param params
//         as returned by parseParams or null/undefined
//
function getBooleanParamValue(params, name, defaultValue) {
    var f = getParamValue(params, name, null);
    if (f === null)
        return defaultValue;
    return (typeof f == "boolean") ? f : f.toString() == "true";
}

Retrieving parameters for macros is then just an easy to read one-liner (at least for the commonly used cases). Here an example:

    var args = paramString.parseParams("list",null,true);

    var buttonAtRight = getBooleanParamValue(args, "buttonAtRight");
    var sizeTextbox = getParamValue(args, "sizeTextbox", this.sizeTextbox);



Udo

[Saq Imtiaz]

On 5/13/06, Udo Borkowski <Udo.Bo...@gmx.de> wrote:

I found the following two helper functions very useful when working with the named parameter feature (i.e. the stuff around the "parseParams" function).

hmm..... does seem more userfriendly than the unwieldy way I handle my named params. However, I'm reluctant to have to throw those functions into every plugin I write.... it would be quite handy to have something like that in the core though. ;)

Saq

[Udo Borkowski]

it would be quite handy to have something like that in the core though. ;)

Nice that you said that ;-)

Udo