Source of: /manual/en/function.rawurlencode.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.url.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.rawurlencode.php',
1 => 'rawurlencode',
),
'up' =>
array (
0 => 'ref.url.php',
1 => 'URL Functions',
),
'prev' =>
array (
0 => 'function.rawurldecode.php',
1 => 'rawurldecode',
),
'next' =>
array (
0 => 'function.urldecode.php',
1 => 'urldecode',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.rawurlencode" class="refentry">
<div class="refnamediv">
<h1 class="refname">rawurlencode</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">rawurlencode</span> — <span class="dc-title">URL-encode according to RFC 1738</span></p>
</div>
<a name="function.rawurlencode.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><b>rawurlencode</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$str</tt></span>
)</div>
<p class="para rdfs-comment">
Encodes the given string according to <a href="http://www.faqs.org/rfcs/rfc1738" class="link external">» RFC 1738</a>.
</p>
</div>
<a name="function.rawurlencode.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">str</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The URL to be encoded.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.rawurlencode.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a string in which all non-alphanumeric characters except
<i>-_.</i> have been replaced with a percent
(<i>%</i>) sign followed by two hex digits. This is the
encoding described in <a href="http://www.faqs.org/rfcs/rfc1738" class="link external">» RFC 1738</a> for
protecting literal characters from being interpreted as special URL
delimiters, and for protecting URLs from being mangled by transmission
media with character conversions (like some email systems).
</p>
</div>
<a name="function.rawurlencode.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 including a password in an FTP URL</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">'<a href="ftp://user:'</span><span style="color: #007700">, </span><span style="color: #0000BB">rawurlencode</span><span style="color: #007700">(</span><span style="color: #DD0000">'foo @+%/'</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'@ftp.example.com/x.txt">'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
<a href="ftp://user:foo%20%40%2B%25%2F@ftp.example.com/x.txt">
</pre></div>
</div>
</div><p>
</p>
<p class="para">
Or, if you pass information in a PATH_INFO component of the URL:
</p>
<p class="para">
</p><div class="example">
<p><b>Example #2 <b>rawurlencode()</b> example 2</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">'<a href="http://example.com/department_list_script/'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">rawurlencode</span><span style="color: #007700">(</span><span style="color: #DD0000">'sales and marketing/Miami'</span><span style="color: #007700">), </span><span style="color: #DD0000">'">'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
<a href="http://example.com/department_list_script/sales%20and%20marketing%2FMiami">
</pre></div>
</div>
</div><p>
</p>
</div>
<a name="function.rawurlencode.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.rawurldecode.php" class="function" rel="rdfs-seeAlso">rawurldecode()</a> - Decode URL-encoded strings</li>
<li class="member"><a href="function.urldecode.php" class="function" rel="rdfs-seeAlso">urldecode()</a> - Decodes URL-encoded string</li>
<li class="member"><a href="function.urlencode.php" class="function" rel="rdfs-seeAlso">urlencode()</a> - URL-encodes string</li>
<li class="member"><a href="http://www.faqs.org/rfcs/rfc1738" class="link external">» RFC 1738</a></li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
