Skip to content

Commit

Permalink
Add stubs for Pdo\Pgsql methods
Browse files Browse the repository at this point in the history
  • Loading branch information
Girgias committed Nov 23, 2024
1 parent d5be9ce commit 065428e
Show file tree
Hide file tree
Showing 3 changed files with 237 additions and 0 deletions.
101 changes: 101 additions & 0 deletions reference/pdo_pgsql/pdo/pgsql/escapeidentifier.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="pdo-pgsql.escapeidentifier" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Pdo\Pgsql::escapeIdentifier</refname>
<refpurpose>Description</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Pdo\\Pgsql">
<modifier>public</modifier> <type>string</type><methodname>Pdo\Pgsql::escapeIdentifier</methodname>
<methodparam><type>string</type><parameter>input</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<simpara>
Description.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;

<variablelist>
<varlistentry>
<term><parameter>input</parameter></term>
<listitem>
<simpara>
Description.
</simpara>
</listitem>
</varlistentry>
</variablelist>

</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Description.
</simpara>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
When does this function issue <constant>E_*</constant> level errors,
and/or throw <exceptionname>Exception</exceptionname>s.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example xml:id="pdo-pgsql.escapeidentifier.example.basic">
<title><methodname>Pdo\Pgsql::escapeIdentifier</methodname> example</title>
<simpara>
Description.
</simpara>
<programlisting role="php">
<![CDATA[
<?php
echo "Code example";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Code example
]]>
</screen>
</example>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>PDO::quote</methodname></member>
</simplelist>
</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
-->
134 changes: 134 additions & 0 deletions reference/pdo_pgsql/pdo/pgsql/setnoticecallback.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="pdo-pgsql.setnoticecallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Pdo\Pgsql::setNoticeCallback</refname>
<refpurpose>Description</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Pdo\\Pgsql">
<modifier>public</modifier> <type>void</type><methodname>Pdo\Pgsql::setNoticeCallback</methodname>
<methodparam><type class="union"><type>callable</type><type>null</type></type><parameter>callback</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<simpara>
Description.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;

<variablelist>
<varlistentry>
<term><parameter>callback</parameter></term>
<listitem>
<simpara>
Description.
</simpara>
</listitem>
</varlistentry>
</variablelist>

</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.void;
</simpara>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
When does this function issue <constant>E_*</constant> level errors,
and/or throw <exceptionname>Exception</exceptionname>s.
</simpara>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.X.0</entry>
<entry>
Description
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example xml:id="pdo-pgsql.setnoticecallback.example.basic">
<title><methodname>Pdo\Pgsql::setNoticeCallback</methodname> example</title>
<simpara>
Description.
</simpara>
<programlisting role="php">
<![CDATA[
<?php
echo "Code example";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Code example
]]>
</screen>
</example>
</refsect1>

<refsect1 role="notes">
&reftitle.notes;
<note>
<simpara>
Any notes that don't fit anywhere else should go here.
</simpara>
</note>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>ClassName::otherMethodName</methodname></member>
<member><function>some_function</function></member>
<!-- <member><link linkend="some.id.chunk.to.link">something appendix</link></member> -->
</simplelist>
</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
-->
2 changes: 2 additions & 0 deletions reference/pdo_pgsql/versions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@
<function name="pdo\pgsql::copyfromfile" from="PHP 8 &gt;= 8.4.0"/>
<function name="pdo\pgsql::copytoarray" from="PHP 8 &gt;= 8.4.0"/>
<function name="pdo\pgsql::copytofile" from="PHP 8 &gt;= 8.4.0"/>
<function name="pdo\pgsql::escapeidentifier" from="PHP 8 &gt;= 8.4.0"/>
<function name="pdo\pgsql::getnotify" from="PHP 8 &gt;= 8.4.0"/>
<function name="pdo\pgsql::getpid" from="PHP 8 &gt;= 8.4.0"/>
<function name="pdo\pgsql::lobcreate" from="PHP 8 &gt;= 8.4.0"/>
<function name="pdo\pgsql::lobopen" from="PHP 8 &gt;= 8.4.0"/>
<function name="pdo\pgsql::lobunlink" from="PHP 8 &gt;= 8.4.0"/>
<function name="pdo\pgsql::setnoticecallback" from="PHP 8 &gt;= 8.4.0"/>
</versions>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down

0 comments on commit 065428e

Please sign in to comment.