From 353024abbb12fe78af38867628892586698b5b59 Mon Sep 17 00:00:00 2001
From: Friedhelm Betz <betz@php.net>
Date: Thu, 8 Sep 2005 18:25:44 +0000
Subject: [PATCH] more function skeletons for session_pgsql

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@195513 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../functions/session-pgsql-add-error.xml     |  80 ++++++++++++++
 .../functions/session-pgsql-get-error.xml     | 103 +++++++++++++++++
 .../functions/session-pgsql-get-field.xml     |  81 ++++++++++++++
 .../functions/session-pgsql-reset.xml         |  94 ++++++++++++++++
 .../functions/session-pgsql-set-field.xml     | 104 ++++++++++++++++++
 5 files changed, 462 insertions(+)
 create mode 100644 reference/session_pgsql/functions/session-pgsql-add-error.xml
 create mode 100644 reference/session_pgsql/functions/session-pgsql-get-error.xml
 create mode 100644 reference/session_pgsql/functions/session-pgsql-get-field.xml
 create mode 100644 reference/session_pgsql/functions/session-pgsql-reset.xml
 create mode 100644 reference/session_pgsql/functions/session-pgsql-set-field.xml

diff --git a/reference/session_pgsql/functions/session-pgsql-add-error.xml b/reference/session_pgsql/functions/session-pgsql-add-error.xml
new file mode 100644
index 0000000000..189d301170
--- /dev/null
+++ b/reference/session_pgsql/functions/session-pgsql-add-error.xml
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
+<refentry id="function.session-pgsql-add-error">
+ <refnamediv>
+  <refname>session_pgsql_add_error</refname>
+  <refpurpose>Increments error counts and sets last error message</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>session_pgsql_add_error</methodname>
+   <methodparam><type>int</type><parameter>error_level</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>error_message</parameter></methodparam>
+  </methodsynopsis>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>error_level</parameter></term>
+     <listitem>
+      <para>
+       
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>error_message</parameter></term>
+     <listitem>
+      <para>
+       
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+  &return.success;
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>session_pgsql_get_error</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/session_pgsql/functions/session-pgsql-get-error.xml b/reference/session_pgsql/functions/session-pgsql-get-error.xml
new file mode 100644
index 0000000000..4066e8c4a7
--- /dev/null
+++ b/reference/session_pgsql/functions/session-pgsql-get-error.xml
@@ -0,0 +1,103 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
+<refentry id="function.session-pgsql-get-error">
+ <refnamediv>
+  <refname>session_pgsql_get_error</refname>
+  <refpurpose>Returns number of errors and last error message</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>array</type><methodname>session_pgsql_get_error</methodname>
+   <methodparam choice="opt"><type>bool</type><parameter>with_error_message</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Get the number of errors and optional the errror messages.
+  </para>
+ </refsect1>
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>with_error_message</parameter></term>
+     <listitem>
+      <para>
+       Set to &true; the literal error message for each error is also returned.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   The number of errors are returned as <type>array</type>.
+  </para>
+ </refsect1>
+
+ <!-- Use when examples exist
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>A <function>session_pgsql_get_error</function> example</title>
+    <para>
+     Any text that describes the purpose of the example, or
+     what goes on in the example should go here (inside the
+     <example> tag, not out
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+if ($anexample === true) {
+    echo 'Use the PEAR Coding Standards';
+}
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+Use the PEAR Coding Standards
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+ -->
+
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>session_pgsql_add_error</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/session_pgsql/functions/session-pgsql-get-field.xml b/reference/session_pgsql/functions/session-pgsql-get-field.xml
new file mode 100644
index 0000000000..bda3de550d
--- /dev/null
+++ b/reference/session_pgsql/functions/session-pgsql-get-field.xml
@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
+<refentry id="function.session-pgsql-get-field">
+ <refnamediv>
+  <refname>session_pgsql_get_field</refname>
+  <refpurpose>Get custom field value</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>string</type><methodname>session_pgsql_get_field</methodname>
+   <void/>
+  </methodsynopsis>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <!-- Use when examples exist
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>A <function>session_pgsql_get_field</function> example</title>
+    <para>
+     Any text that describes the purpose of the example, or
+     what goes on in the example should go here (inside the
+     <example> tag, not out
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+if ($anexample === true) {
+    echo 'Use the PEAR Coding Standards';
+}
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+Use the PEAR Coding Standards
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+ -->
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>session_pgsql_set_field</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/session_pgsql/functions/session-pgsql-reset.xml b/reference/session_pgsql/functions/session-pgsql-reset.xml
new file mode 100644
index 0000000000..07890620d7
--- /dev/null
+++ b/reference/session_pgsql/functions/session-pgsql-reset.xml
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
+<refentry id="function.session-pgsql-reset">
+ <refnamediv>
+  <refname>session_pgsql_reset</refname>
+  <refpurpose>Reset connection to session database servsers</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>session_pgsql_reset</methodname>
+   <void/>
+  </methodsynopsis>
+  <para>
+   Reset the connection to the seession database server.
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
+
+ <!-- Use when examples exist
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>A <function>session_pgsql_reset</function> example</title>
+    <para>
+     Any text that describes the purpose of the example, or
+     what goes on in the example should go here (inside the
+     <example> tag, not out
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+if ($anexample === true) {
+    echo 'Use the PEAR Coding Standards';
+}
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+Use the PEAR Coding Standards
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+ -->
+
+
+ <!-- Use when adding See Also links
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function></function></member>
+    <member>Or <link linkend="somethingelse">something else</link></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/session_pgsql/functions/session-pgsql-set-field.xml b/reference/session_pgsql/functions/session-pgsql-set-field.xml
new file mode 100644
index 0000000000..8c0e72502e
--- /dev/null
+++ b/reference/session_pgsql/functions/session-pgsql-set-field.xml
@@ -0,0 +1,104 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
+<refentry id="function.session-pgsql-set-field">
+ <refnamediv>
+  <refname>session_pgsql_set_field</refname>
+  <refpurpose>Set custom field value</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>session_pgsql_set_field</methodname>
+   <methodparam><type>string</type><parameter>value</parameter></methodparam>
+  </methodsynopsis>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>value</parameter></term>
+     <listitem>
+      <para>
+       
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
+ <!-- Use when examples exist
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>A <function>session_pgsql_set_field</function> example</title>
+    <para>
+     Any text that describes the purpose of the example, or
+     what goes on in the example should go here (inside the
+     <example> tag, not out
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+if ($anexample === true) {
+    echo 'Use the PEAR Coding Standards';
+}
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+Use the PEAR Coding Standards
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+ -->
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>session_pgsql_get_field</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
+-->