From 9cf46353a10d64d480efe6aa4d0c0f707620cc43 Mon Sep 17 00:00:00 2001
From: Hannes Magnusson <bjori@php.net>
Date: Fri, 20 Mar 2009 12:05:11 +0000
Subject: [PATCH] Initial docs for stream_is_local() and
 stream_context_get_params()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@277514 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../functions/stream-context-get-params.xml   | 113 ++++++++++++++++++
 .../stream/functions/stream-is-local.xml      | 103 ++++++++++++++++
 reference/stream/versions.xml                 |   3 +-
 3 files changed, 218 insertions(+), 1 deletion(-)
 create mode 100644 reference/stream/functions/stream-context-get-params.xml
 create mode 100644 reference/stream/functions/stream-is-local.xml

diff --git a/reference/stream/functions/stream-context-get-params.xml b/reference/stream/functions/stream-context-get-params.xml
new file mode 100644
index 0000000000..4531023b33
--- /dev/null
+++ b/reference/stream/functions/stream-context-get-params.xml
@@ -0,0 +1,113 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+
+<refentry xml:id="function.stream-context-get-params" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>stream_context_get_params</refname>
+  <refpurpose>Retrieves parameters from a context</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>array</type><methodname>stream_context_get_params</methodname>
+   <methodparam><type>resource</type><parameter>stream_or_context</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Retrieves parameter and options information from the stream or context.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>stream_or_context</parameter></term>
+     <listitem>
+      <para>
+       A stream <type>resource</type> or a
+       <link linkend="context">context</link> <type>resource</type>
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns an associate array containing all context options and parameters.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><function>stream_context_get_params</function> example</title>
+    <para>
+     Basic usage example
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$ctx = stream_context_create();
+$params = array("notification" => "stream_notification_callback");
+stream_context_set_params($ctx, $params);
+
+var_dump(stream_context_get_params($ctx));
+?>
+]]>
+    </programlisting>
+    &example.outputs.similar;
+    <screen>
+<![CDATA[
+array(2) {
+  ["notification"]=>
+  string(28) "stream_notification_callback"
+  ["options"]=>
+  array(0) {
+  }
+}
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>stream_context_set_option</function></member>
+    <member><function>stream_context_get_params</function></member>
+    <member><function>stream_context_set_params</function></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:"../../../../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
+-->
+
diff --git a/reference/stream/functions/stream-is-local.xml b/reference/stream/functions/stream-is-local.xml
new file mode 100644
index 0000000000..78572afc2e
--- /dev/null
+++ b/reference/stream/functions/stream-is-local.xml
@@ -0,0 +1,103 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+
+<refentry xml:id="function.stream-is-local" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>stream_is_local</refname>
+  <refpurpose>Checks if a stream is a local stream</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>stream_is_local</methodname>
+   <methodparam><type>mixed</type><parameter>stream_or_url</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Checks if a stream, or a URL, is a local one or not.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>stream_or_url</parameter></term>
+     <listitem>
+      <para>
+       The stream <type>resource</type> or URL to check.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><function>stream_is_local</function> example</title>
+    <para>
+     Basic usage example.
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+var_dump(stream_is_local("http://example.com"));
+var_dump(stream_is_local("/etc"));
+?>
+]]>
+    </programlisting>
+    &example.outputs.similar;
+    <screen>
+<![CDATA[
+bool(false)
+bool(true)
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+
+<!--
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>related function name here</function></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:"../../../../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
+-->
diff --git a/reference/stream/versions.xml b/reference/stream/versions.xml
index f8e6b95bba..95fda35887 100644
--- a/reference/stream/versions.xml
+++ b/reference/stream/versions.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='utf-8'?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
 <!--
   Do NOT translate this file
 -->
@@ -11,6 +11,7 @@
  <function name='stream_context_create' from='PHP 4 &gt;= 4.3.0, PHP 5'/>
  <function name='stream_context_get_default' from='PHP 5 &gt;= 5.1.0'/>
  <function name='stream_context_get_options' from='PHP 4 &gt;= 4.3.0, PHP 5'/>
+ <function name='stream_context_get_params' from='PHP 5 &gt;= 5.3.0'/>
  <function name='stream_context_set_default' from='PHP 5 &gt;= 5.3.0'/>
  <function name='stream_context_set_option' from='PHP 4 &gt;= 4.3.0, PHP 5'/>
  <function name='stream_context_set_params' from='PHP 4 &gt;= 4.3.0, PHP 5'/>