p:www-form-urlencode (3.0) 

Summary

<p:declare-step type="p:www-form-urlencode">
  <output port="result" primary="true" content-types="text/plain" sequence="true"/>
  <option name="parameters" as="map(xs:string,xs:anyAtomicType+)" required="true"/>
</p:declare-step>

The p:www-form-urlencode step encodes a set of parameters, given as entries in a map, into a URL parameter string (like a=b&c=d). The result appears on the result port as a text document.

Ports:

Options:

Description

The p:www-form-urlencode step is one of the few steps that have no primary input port, its main input is the value of the parameters option. This value must be a map. The keys in the map are the parameter names, the value(s) the parameter values. The result will be a parameter string (the part that usually comes after the ? in a URL, like a=b&c=d). Officially, this is called a x-www-form-urlencoded string. This format is also used for sending HTML form data over HTTP.

The resulting parameter string appears on the result port as a text document.

There is also a step for decoding these kinds of strings, called p:www-form-urldecode.

Examples

<p:declare-step xmlns:p="http://www.w3.org/ns/xproc" version="3.0">

  <p:output port="result"/>

  <p:www-form-urlencode parameters="map{ 'a': 'b', 'c': 'd e f' }"/>

</p:declare-step>

a=b&c=d+e+f

<p:declare-step xmlns:p="http://www.w3.org/ns/xproc" version="3.0">

  <p:output port="result"/>

  <p:www-form-urlencode parameters="map{ 'a': ('b', 'b2'), 'c': 'd e f' }"/>

</p:declare-step>

a=b&a=b2&c=d+e+f

Additional details

• The document appearing on the result port only has a content-type property. It has no other document-properties (also no base-uri).

• If an entry in the map has multiple values, an entry for each value will appear in the resulting URL string. See also the Multiple parameter values example.