[prev in list] [next in list] [prev in thread] [next in thread] 

List:       pear-doc
Subject:    [PEAR-DOC] cvs: peardoc /en/package/networking/net-url instantiate.xml setOption.xml
From:       "David Coallier" <davidc () php ! net>
Date:       2007-05-08 1:52:01
Message-ID: cvsdavidc1178589121 () cvsserver
[Download RAW message or body]

davidc		Tue May  8 01:52:01 2007 UTC

  Added files:                 
    /peardoc/en/package/networking/net-url	instantiate.xml 
                                          	setOption.xml 
  Log:
  - First draft of end-user doc for net-url
  
  

http://cvs.php.net/viewvc.cgi/peardoc/en/package/networking/net-url/instantiate.xml?view=markup&rev=1.1
Index: peardoc/en/package/networking/net-url/instantiate.xml
+++ peardoc/en/package/networking/net-url/instantiate.xml
<!-- $Revision: 1.1 $ -->
<refentry id="package.networking.net-url.instantiate">
   <refnamediv>
    <refname>Net_URL Instantiate</refname>
    <refpurpose>Instantiating Net_URL</refpurpose>
   </refnamediv>
   <refsynopsisdiv>
    <funcsynopsis>
     <funcsynopsisinfo>
      require_once 'Net/URL.php';
     </funcsynopsisinfo>
    <funcprototype>
     <funcdef>string <function>Net_Whois</function></funcdef>
     <paramdef>string <parameter>$url</parameter></paramdef>
     <paramdef>string <parameter>$useBrackets</parameter></paramdef>
    </funcprototype>
    </funcsynopsis>
   </refsynopsisdiv>
   <refsect1 id="package.networking.net-url.instantiate.desc">
    &title.desc;
    <para>
     Instantiates a new Net_URL object
    </para>
   </refsect1>
   <refsect1 id="package.networking.net-url.instantiate.parameter">
    &title.param;
    <para>
     <itemizedlist>
      <listitem>
       <para>
        <parameter>string $url</parameter> -
        The url to parse. By default this is getting $_SERVER['PHP_SELF']
       </para>
      </listitem>
      <listitem>
       <para>
        <parameter>string $useBrackets</parameter> - 
         Whether to use sqare brackets or not when there is multiple
         query variable names using the same name.
        </para>
      </listitem>
     </itemizedlist>
    </para>
   </refsect1>
   <refsect1 id="package.networking.net-url.instantiate.example">
    &title.example;
    <example>
     <title>Using Net_URL</title>
      <programlisting role="php">
       <![CDATA[
<?php
require_once 'Net/URL.php';
$url = new Net_URL;
print_r($url->querystring);
?>
]]>
     </programlisting>
    </example>
   </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
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../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
-->

http://cvs.php.net/viewvc.cgi/peardoc/en/package/networking/net-url/setOption.xml?view=markup&rev=1.1
Index: peardoc/en/package/networking/net-url/setOption.xml
+++ peardoc/en/package/networking/net-url/setOption.xml
<!-- $Revision: 1.1 $ -->
<refentry id="package.networking.net-url.setOption">
   <refnamediv>
    <refname>Net_URL::setOption</refname>
    <refpurpose>Setting options with Net_URL</refpurpose>
   </refnamediv>
   <refsynopsisdiv>
    <funcsynopsis>
     <funcsynopsisinfo>
      require_once 'Net/URL.php';
     </funcsynopsisinfo>
    <funcprototype>
     <funcdef>string <function>setOption</function></funcdef>
     <paramdef>string <parameter>$optionName</parameter></paramdef>
     <paramdef>string <parameter>$value</parameter></paramdef>
    </funcprototype>
    </funcsynopsis>
   </refsynopsisdiv>
   <refsect1 id="package.networking.net-url.setOption.desc">
    &title.desc;
    <para>
     Setting a Net_URL option
    </para>
   </refsect1>
   <refsect1 id="package.networking.net-url.setOption.parameter">
    &title.param;
    <para>
     <table>
      <title>List of options</title>
      <tgroup cols="2">
       <thead>
        <row>
         <entry>Name</entry>
         <entry>Description</entry>
        </row>
       </thead>
       <tbody>
        <row>
         <entry>encode_query_keys</entry>
         <entry>This will encode the query keys if set to true. By default set
         to false.</entry>
        </row>
       </tbody>
      </tgroup>
     </table>
    </para>
    <para>
     <itemizedlist>
      <listitem>
       <para>
        <parameter>string $optionName</parameter> -
        The option name to set.
       </para>
      </listitem>
      <listitem>
       <para>
        <parameter>string $value</parameter> - 
         The value of the option to set.
        </para>
      </listitem>
     </itemizedlist>
    </para>
   </refsect1>
   <refsect1 id="package.networking.net-url.setOption.example">
    &title.example;
    <example>
     <title>Using Net_URL</title>
      <programlisting role="php">
       <![CDATA[
<?php
require_once 'Net/URL.php';
$url = new Net_URL;
$url->setOption('encode_query_keys', true);
print_r($url->querystring);
?>
]]>
     </programlisting>
    </example>
   </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
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../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
-->

-- 
PEAR Documentation List Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php

[prev in list] [next in list] [prev in thread] [next in thread]