This is a Javascript version of the PHP function: http_build_query.

PHP http_build_query

Description

http_build_query - Generate URL-encoded query string

string http_build_query( array formdata [, string numeric_prefix [, string arg_separator]] )

Generates a URL-encoded query string from the associative (or indexed) array provided.

Parameters

• formdata

  May be an array or object containing properties.

  The array form may be a simple one-dimensional structure, or an array of arrays (who in turn may contain other arrays).

• numeric_prefix

  If numeric indices are used in the base array and this parameter is provided, it will be prepended to the numeric index for elements in the base array only.

  This is meant to allow for legal variable names when the data is decoded by PHP or another CGI application later on.

• arg_separator

  arg_separator.output is used to separate arguments, unless this parameter is specified, and is then used.

Return Values

Returns a URL-encoded string.

See Also

• javascript parse_str()
• javascript urlencode()

Javascript http_build_query

Source

This is the main source of the Javascript version of PHP's http_build_query

function http_build_query( formdata, numeric_prefix, arg_separator ) {
    // http://kevin.vanzonneveld.net
    // +   original by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
    // +   improved by: Legaev Andrey
    // +   improved by: Michael White (http://crestidg.com)
    // *     example 1: http_build_query({ foo: 'bar', baz: 'boom', cow: 'milk', php: 'hypertext processor' }, '', '&');
    // *     returns 1: 'foo=bar&baz=boom&cow=milk&php=hypertext+processor'
    // *     example 2: http_build_query({0: 'foo', 1: 'bar', 2: 'baz', 3: 'boom', cow: 'milk', php :'hypertext processor'}, 'myvar_');
    // *     returns 2: 'myvar_0=foo&myvar_1=bar&myvar_2=baz&myvar_3=boom&cow=milk&php=hypertext+processor'
 
    var key, use_val, use_key, i = 0, tmp_arr = [];
 
    if(!arg_separator){
        arg_separator = '&';
    }
 
    for(key in formdata){
        use_key = encodeURIComponent(key);
        use_val = encodeURIComponent((formdata[key].toString()));
        use_val = use_val.replace(/%20/g, '+');
 
        if(numeric_prefix && !isNaN(key)){
            use_key = numeric_prefix + i;
        }
        tmp_arr[i] = use_key + '=' + use_val;
        i++;
    }
 
    return tmp_arr.join(arg_separator);
}

Examples

Currently there are 2 examples

Example 1

http_build_query({ foo: 'bar', baz: 'boom', cow: 'milk', php: 'hypertext processor' }, '', '&');

'foo=bar&baz=boom&cow=milk&php=hypertext+processor'

Example 2

http_build_query({0: 'foo', 1: 'bar', 2: 'baz', 3: 'boom', cow: 'milk', php :'hypertext processor'}, 'myvar_');

'myvar_0=foo&myvar_1=bar&myvar_2=baz&myvar_3=boom&cow=milk&php=hypertext+processor'

More about this Project

Download php.js

To easily include it in your code, every function currently available is stored in

Normal

• uncompressed source: php.js (147.1kB)
• minified: php.min.js (54.1kB)
• compressed: php.packed.js (39kB)

Namespaced What is 'namespaced?'

• uncompressed source: php.namespaced.js (181.6kB)
• minified: php.namespaced.min.js (54.5kB)
• compressed: php.namespaced.packed.js (39.4kB)

To download use Right click, Save Link As
Generally the best way is to use a minified version and gzip it

Testing the functions

The number of functions is growing fast and so it becomes hard to maintain quality.

To defeat that danger of bad code, syntax errors, etc, I've added a new feature: php.js tester.

It is an automatically generated page that includes ALL functions in your browser, and then extracts specific testing information from each function's comments. This info is then used to run the function, and the return value is compared to a predefined one.

This way code is always checked on syntax errors, and if it doesn't function correctly anymore after an update, we should also be able to detect it more easily.

If you want, go check it out.

Credits

Respect & awards go to everybody who has contributed in some way so far:

	Michael White (link) for contributing to:
	array_count_values, get_included_files, include, include_once, require, require_once, md5, number_format, parse_str, printf, sha1, sprintf, str_pad, strnatcmp, http_build_query, floatval, is_object, print_r
	_argos for contributing to:
	array_fill, array_pad, array_product, array_rand, compact, count, range, abs, defined, ip2long, long2ip, implode, strcmp, ucwords
	Jonas Raoni Soares Silva (link) for contributing to:
	shuffle, abs, setcookie, number_format, number_format, soundex, str_repeat, str_replace, str_rot13, ucwords, wordwrap, wordwrap
	Legaev Andrey for contributing to:
	end, reset, file, file_get_contents, function_exists, include, include_once, http_build_query, is_array, is_object
	Ates Goral (link) for contributing to:
	array_change_key_case, array_count_values, array_diff_key, get_class, preg_quote, addslashes, count_chars, str_rot13, stripslashes
	Philip Peterson for contributing to:
	sizeof, round, echo, nl2br, str_replace, strchr, urldecode, urlencode, var_export
	Martijn Wieringa for contributing to:
	str_ireplace, str_split, strcasecmp, stripos, strnatcmp, substr
	Webtoolkit.info (link) for contributing to:
	crc32, md5, sha1, utf8_decode, utf8_encode
	Carlos R. L. Rodrigues (link) for contributing to:
	array_chunk, array_unique, date, levenshtein
	Ash Searle (link) for contributing to:
	basename, printf, sprintf
	Erkekjetter for contributing to:
	ltrim, rtrim, trim
	marrtins for contributing to:
	array_change_key_case, addslashes, stripslashes
	Alfonso Jimenez (link) for contributing to:
	array_reduce, strpbrk
	Aman Gupta for contributing to:
	base64_decode, utf8_decode
	Arpad Ray (mailto:arpad@php.net) for contributing to:
	serialize, unserialize
	Karol Kowalski for contributing to:
	array_reverse, abs
	Thunder.m for contributing to:
	base64_decode, base64_encode
	Tyler Akins (link) for contributing to:
	base64_decode, base64_encode
	mdsjack (link) for contributing to:
	include, trim
	Alexander Ermolaev (link) for contributing to:
	trim
	Allan Jensen (link) for contributing to:
	number_format
	Andrea Giammarchi (link) for contributing to:
	array_map
	Bayron Guevara for contributing to:
	base64_encode
	Benjamin Lupton for contributing to:
	number_format
	Brad Touesnard for contributing to:
	date
	Brett Zamir for contributing to:
	str_split
	Cagri Ekin for contributing to:
	parse_str
	Cord for contributing to:
	is_array
	David for contributing to:
	is_numeric
	David James for contributing to:
	get_class
	DxGx for contributing to:
	trim
	FGFEmperor for contributing to:
	mktime
	Felix Geisendoerfer (link) for contributing to:
	array_key_exists
	FremyCompany for contributing to:
	isset
	Gabriel Paderni for contributing to:
	str_replace
	Leslie Hoare for contributing to:
	rand
	Lincoln Ramsay for contributing to:
	basename
	MeEtc (link) for contributing to:
	date
	Mick@el for contributing to:
	stripslashes
	Nick Callen for contributing to:
	wordwrap
	Ozh for contributing to:
	dirname
	Pedro Tainha (link) for contributing to:
	unserialize
	Peter-Paul Koch (link) for contributing to:
	date
	Philippe Baumann for contributing to:
	empty
	Sakimori for contributing to:
	strlen
	Sanjoy Roy for contributing to:
	array_diff
	Simon Willison (link) for contributing to:
	str_replace
	Steve Clay for contributing to:
	function_exists
	Steve Hilder for contributing to:
	strcmp
	Steven Levithan (link) for contributing to:
	trim
	T0bsn for contributing to:
	crc32
	Thiago Mata (link) for contributing to:
	call_user_func_array
	Tim Wiel for contributing to:
	date
	XoraX (link) for contributing to:
	dirname
	baris ozdil for contributing to:
	mktime
	booeyOH for contributing to:
	preg_quote
	djmix for contributing to:
	basename
	duncan for contributing to:
	array_unique
	echo is bad for contributing to:
	echo
	gabriel paderni for contributing to:
	mktime
	ger for contributing to:
	html_entity_decode
	john (link) for contributing to:
	html_entity_decode
	kenneth for contributing to:
	explode
	penutbutterjelly for contributing to:
	str_ireplace
	stensi for contributing to:
	intval

Your name here?

Contributing is as easy as adding a comment with better code, or code for a new function.
Any contribution leading to improvement will directly get your name & link here.

Coming Project features

Project features that we are currently working on:

• Versioning. Individual functions are versioned, but the entire library should be versioned as well.
• Light. A lightweight version of php.js should be made available with only common functions in it.