Document new function

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@164013 c90b9560-bf6c-de11-be94-00142212c4b1

reference/stream/functions/stream-context-get-default.xml

@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+  <refentry id="function.stream-context-get-default">
+   <refnamediv>
+    <refname>stream_context_get_default</refname>
+    <refpurpose>Retreive the default streams context</refpurpose> 
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+     <methodsynopsis>
+      <type>resource</type><methodname>stream_context_get_default</methodname>
+      <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
+     </methodsynopsis>
+    <simpara>
+     Returns the default stream context which is used whenever file operations
+     (<function>fopen</function>, <function>file_get_contents</function>, etc...)
+     are called without a context parameter.  Options for the default context
+     can optionally be specified with this function using the same syntax as
+     <function>stream_context_cretae</function>.
+    </simpara>
+    <simpara>
+     <parameter>options</parameter> must be an associative 
+     array of associative arrays in the format 
+     <literal>$arr['wrapper']['option'] = $value</literal>.
+    </simpara>
+    <example>
+     <title>Using <function>stream_context_get_default</function></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"
+  )
+);
+
+
+$alternate_opts = array(
+  'http'=>array(
+    'method'=>"POST",
+    'header'=>"Content-type: application/x-www-form-urlencoded\r\n" .
+              "Content-length: " . strlen("baz=bomb"),
+    'content'=>"baz=bomb"
+  )
+);
+
+$default = stream_context_get_default($default_opts);
+$alternate = stream_context_create($alternate_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');
+
+/* Sends a POST request directly to www.example.com
+ * Using context options specified in $alternate_opts
+ */
+readfile('http://www.example.com', false, $alternate);
+
+?>
+]]>
+     </programlisting>
+    </example>
+    <simpara>
+     See also
+     <function>stream_context_create</function>, and
+     Listing of supported wrappers with context options (<xref linkend="wrappers"/>).
+    </simpara>
+   </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:"../../../../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
+-->