[prev in list] [next in list] [prev in thread] [next in thread] 

List:       php-doc-cvs
Subject:    [DOC-CVS] =?utf-8?q?svn:_/phpdoc/en/trunk/reference/mysqli/_mysqli=5Fstmt/construct.xml_mysqli=5Fstm
From:       Adam_Harvey <aharvey () php ! net>
Date:       2015-02-27 20:20:06
Message-ID: svn-aharvey-1425068406-336012-1768062212 () svn ! php ! net
[Download RAW message or body]

aharvey                                  Fri, 27 Feb 2015 20:20:06 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=336012

Log:
Add documentation for mysqli_stmt::__construct().

Changed paths:
    A   phpdoc/en/trunk/reference/mysqli/mysqli_stmt/construct.xml
    U   phpdoc/en/trunk/reference/mysqli/mysqli_stmt.xml
    U   phpdoc/en/trunk/reference/mysqli/versions.xml

Added: phpdoc/en/trunk/reference/mysqli/mysqli_stmt/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/mysqli/mysqli_stmt/construct.xml	                       \
                (rev 0)
+++ phpdoc/en/trunk/reference/mysqli/mysqli_stmt/construct.xml	2015-02-27 20:20:06 \
UTC (rev 336012) @@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="mysqli-stmt.construct" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv>
+  <refname>mysqli_stmt::__construct</refname>
+  <refpurpose>Constructs a new <classname>mysqli_stmt</classname> \
object</refpurpose> + </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <constructorsynopsis>
+   <methodname>mysqli_stmt::__construct</methodname>
+   <methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>query</parameter></methodparam>
 +  </constructorsynopsis>
+  <para>
+   This method constructs a new <classname>mysqli_stmt</classname> object.
+  </para>
+  <note>
+   <para>
+    In general, you should use either <function>mysqli_prepare</function> or
+    <function>mysqli_stmt_init</function> to create a
+    <classname>mysqli_stmt</classname> object, rather than directly
+    instantiating the object with <literal>new mysqli_stmt</literal>. This
+    method (and the ability to directly instantiate
+    <classname>mysqli_stmt</classname> objects) may be deprecated and removed
+    in the future.
+   </para>
+  </note>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    &mysqli.link.description;
+    <varlistentry>
+     <term><parameter>query</parameter></term>
+     <listitem>
+      <para>
+       The query, as a string. If this parameter is omitted, then the
+       constructor behaves identically to
+       <function>mysqli_stmt_init</function>, if provided, then it behaves as
+       per <function>mysqli_prepare</function>.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>mysqli_prepare</function></member>
+    <member><function>mysqli_stmt_init</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:"~/.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
+-->

Modified: phpdoc/en/trunk/reference/mysqli/mysqli_stmt.xml
===================================================================
--- phpdoc/en/trunk/reference/mysqli/mysqli_stmt.xml	2015-02-27 20:04:45 UTC (rev \
                336011)
+++ phpdoc/en/trunk/reference/mysqli/mysqli_stmt.xml	2015-02-27 20:20:06 UTC (rev \
336012) @@ -34,6 +34,7 @@
     <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) \
xpointer(id('class.mysqli-stmt')/db:refentry/db:refsect1[@role='description']/descendant::db:fieldsynopsis[1])" \
/>

     <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) \
xpointer(id('class.mysqli-stmt')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" \
/>  <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) \
xpointer(id('class.mysqli-stmt')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='oop'])" \
/>  </classsynopsis>
 <!-- }}} -->

Modified: phpdoc/en/trunk/reference/mysqli/versions.xml
===================================================================
--- phpdoc/en/trunk/reference/mysqli/versions.xml	2015-02-27 20:04:45 UTC (rev \
                336011)
+++ phpdoc/en/trunk/reference/mysqli/versions.xml	2015-02-27 20:20:06 UTC (rev \
336012) @@ -16,6 +16,7 @@
  <function name='mysqli::protocol_version' from='PHP 5'/>
  <function name='mysqli::server_info' from='PHP 5'/>
  <function name='mysqli::server_version' from='PHP 5'/>
+ <function name='mysqli_stmt::__construct' from='PHP 5'/>

  <function name='mysqli_affected_rows' from='PHP 5'/>
  <function name='mysqli_autocommit' from='PHP 5'/>



-- 
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php

[prev in list] [next in list] [prev in thread] [next in thread]