cvs: phpdoc /en/reference/stream/functions stream-context-create.xml

From: Date: Mon, 14 Apr 2008 08:18:36 +0000
Subject: cvs: phpdoc /en/reference/stream/functions stream-context-create.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-1491@lists.php.net to get a copy of this message
bjori Mon Apr 14 08:18:36 2008 UTC Modified files: /phpdoc/en/reference/stream/functions stream-context-create.xml Log: - Update to new-doc-style - The "params" argument is available as of 5.3 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/stream/functions/stream-context-create.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/stream/functions/stream-context-create.xml diff -u phpdoc/en/reference/stream/functions/stream-context-create.xml:1.7 phpdoc/en/reference/stream/functions/stream-context-create.xml:1.8 --- phpdoc/en/reference/stream/functions/stream-context-create.xml:1.7 Sun Dec 30 00:26:59 2007 +++ phpdoc/en/reference/stream/functions/stream-context-create.xml Mon Apr 14 08:18:36 2008 @@ -1,39 +1,80 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry xml:id="function.stream-context-create" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>stream_context_create</refname> <refpurpose>Create a streams context</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>stream_context_create</methodname> <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>params</parameter></methodparam> </methodsynopsis> - <simpara> + <para> Creates and returns a stream context with any options supplied in <parameter>options</parameter> preset. - </simpara> - <simpara> - <parameter>options</parameter> must be an associative - array of associative arrays in the format - <literal>$arr['wrapper']['option'] = $value</literal>. - It defaults to an empty array. - </simpara> - <simpara> - <parameter>params</parameter> must be an associative array - in the format <literal>$arr['parameter'] = $value</literal>. - Refer to <function>stream_context_set_params</function> for - a listing of standard stream parameters. - </simpara> - <note> - <simpara> - The <parameter>params</parameter> argument - was added to <literal>PHP 6.0.0</literal>. - </simpara> - </note> + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + Must be an associative array of associative arrays in the format + <literal>$arr['wrapper']['option'] = $value</literal>. + </para> + <para> + Default to an empty array. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>params</parameter></term> + <listitem> + <para> + Must be an associative array in the format + <literal>$arr['parameter'] = $value</literal>. + Refer to <function>stream_context_set_params</function> for + a listing of standard stream parameters. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>5.3.0</entry> + <entry> + Added the optional <parameter>params</parameter> argument. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <example> <title>Using <function>stream_context_create</function></title> <programlisting role="php"> @@ -58,11 +99,14 @@ ]]> </programlisting> </example> - <simpara> - See also - <function>stream_context_set_option</function>, and - Listing of supported wrappers with context options (<xref linkend="wrappers"/>). - </simpara> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <simplelist> + <member><function>stream_context_set_option</function></member> + <member>Listing of supported wrappers with context options (<xref linkend="wrappers"/>).</member> + </simplelist> </refsect1> </refentry>

« previous php.doc.cvs (#1491) next »