stream-context-set-default.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.stream-context-set-default" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>stream_context_set_default</refname>
  <refpurpose>Set the default stream context</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>stream_context_set_default</methodname>
   <methodparam><type>array</type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   Set the default stream context which will be used whenever file operations
   (<function>fopen</function>, <function>file_get_contents</function>, etc...)
   are called without a context parameter. Uses the same syntax as
   <function>stream_context_create</function>.
  </simpara>
 </refsect1>
 
 <refsect1 role="parameters"><!-- {{{ -->
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       The options to set for the default context.
      </para>
      <note>
       <para>
        <parameter>options</parameter> must be an associative
        array of associative arrays in the format
        <literal>$arr['wrapper']['option'] = $value</literal>.
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="returnvalues"><!-- {{{ -->
  &reftitle.returnvalues;
  <para>
   Returns the default stream context. 
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="examples"><!-- {{{ -->
  &reftitle.examples;
  <para>
   <example xml:id="stream-context-set-default.example.basic"><!-- {{{ -->
    <title><function>stream_context_set_default</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$default_opts = array(
  'http'=>array(
    'method'=>"GET",
    'header'=>"Accept-language: en\r\n" .
              "Cookie: foo=bar",
    'proxy'=>"tcp://10.54.1.39:8000"
  )
);

$default = stream_context_set_default($default_opts);

/* Sends a regular GET request to proxy server at 10.54.1.39
 * For www.example.com using context options specified in $default_opts
 */
readfile('http://www.example.com');
?>
]]>
    </programlisting>
   </example><!-- }}} -->
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="seealso"><!-- {{{ -->
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>stream_context_create</function></member>
    <member><function>stream_context_get_default</function></member>
    <member>Listing of supported wrappers with context options (<xref linkend="wrappers"/>).</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
-->