1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
|
<?xml version="1.0" encoding="utf-8"?>
<reference xml:id="class.pdorow" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The PDORow class</title>
<titleabbrev>PDORow</titleabbrev>
<partintro>
<!-- {{{ PDORow intro -->
<section xml:id="pdorow.intro">
&reftitle.intro;
<para>
Represents a row from a result set returned
by <methodname>PDOStatement::fetch</methodname>
called with <constant>PDO_FETCH_LAZY</constant> fetch mode.
</para>
<para>
Objects of this class cannot be instantiated and are not serializable.
</para>
<para>
The <classname>PDORow</classname> object allows access
to the returned data as if both <constant>PDO::FETCH_OBJ</constant>
and <constant>PDO::FETCH_BOTH</constant> mode was used.
This means that the returned data can be accessed as object properties,
and as an array both indexed by the column name and a column offset number.
</para>
<caution>
<simpara>
Accessing an undefined property returns &null;
without emitting a warning.
</simpara>
</caution>
</section>
<!-- }}} -->
<section xml:id="pdorow.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis class="class">
<ooclass>
<modifier>final</modifier>
<classname>PDORow</classname>
</ooclass>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="pdorow.props.querystring">queryString</varname>
</fieldsynopsis>
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ PDORow properties -->
<section xml:id="pdorow.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="pdorow.props.querystring">
<term><varname>queryString</varname></term>
<listitem>
<para>
Query string used by the <classname>PDOStatement</classname>
that returned the <classname>PDORow</classname> object.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<section role="errors">
&reftitle.errors;
<para>
Throws an <classname>Error</classname> when trying to
write to or <function>unset</function> any property.
</para>
</section>
</partintro>
</reference>
<!-- 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
-->
|