rawurlencode.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f9c4a68ef4f89e51e6d9b905ad3ddb6492386dd3 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.rawurlencode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>rawurlencode</refname>
  <refpurpose>RFC 3986 に基づき URL エンコードを行う</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>rawurlencode</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
  </methodsynopsis>
  <para>
   指定した文字列を <link
   xlink:href="&url.rfc;3986">RFC 3986</link>
   にもとづいてエンコードします。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       エンコードする URL。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <literal>-_.~</literal> を除くすべての非アルファベット文字をパーセント
   記号 (<literal>%</literal>)に続いて 2 つの 16 進数がある表現形式に
   置き換えた文字列を返します。これは、文字定数が特殊な URL デリミタと
   して解釈されたり、URL デリミタが(いくつかの電子メールシステムのような)
   転送メディアにより文字変換されて失われてしまったりすることが
   ないように、<link xlink:href="&url.rfc;3986">RFC 3986</link>
   で定められたエンコーディング方法です。
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>FTP URL へのパスワードの埋め込み</title>
    <programlisting role="php">
<![CDATA[
<?php
echo '<a href="ftp://user:', rawurlencode('foo @+%/'),
     '@ftp.example.com/x.txt">';
?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="html">
<![CDATA[
<a href="ftp://user:foo%20%40%2B%25%2F@ftp.example.com/x.txt">
]]>
    </screen>
   </example>
  </para>
  <para>
   あるいは、URL の PATH_INFO 中の情報を渡した場合は、
  </para>
  <para>
   <example>
    <title><function>rawurlencode</function> の例 2</title>
    <programlisting role="php">
<![CDATA[
<?php
echo '<a href="http://example.com/department_list_script/',
    rawurlencode('sales and marketing/Miami'), '">';
?>
]]>
    </programlisting>
    &example.outputs;
    <screen role="html">
<![CDATA[
<a href="http://example.com/department_list_script/sales%20and%20marketing%2FMiami">
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>rawurldecode</function></member>
    <member><function>urldecode</function></member>
    <member><function>urlencode</function></member>
    <member><link xlink:href="&url.rfc;3986">RFC 3986</link></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->