mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
115 lines
3.3 KiB
XML
115 lines
3.3 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.hw-getobject" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>hw_GetObject</refname>
|
|
<refpurpose>Object record</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>hw_getobject</methodname>
|
|
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
|
|
<methodparam><type>mixed</type><parameter>objectID</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>query</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Gets an object record.
|
|
If the second parameter is an array of integer the function will
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>connection</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The connection identifier.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>objectID</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The object identifier, or an array of identifiers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>query</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The query string has the following syntax:
|
|
<screen>
|
|
<![CDATA[
|
|
<expr> ::= "(" <expr> ")" |
|
|
"!" <expr> | /* NOT */
|
|
<expr> "||" <expr> | /* OR */
|
|
<expr> "&&" <expr> | /* AND */
|
|
<attribute> <operator> <value>
|
|
|
|
<attribute> ::= /* any attribute name (Title, Author, DocumentType ...) */
|
|
|
|
<operator> ::= "=" | /* equal */
|
|
"<" | /* less than (string compare) */
|
|
">" | /* greater than (string compare) */
|
|
"~" /* regular expression matching */
|
|
]]>
|
|
</screen>
|
|
The query allows to further select certain objects from the list
|
|
of given objects. Unlike the other
|
|
query functions, this query may use not indexed attributes. How many
|
|
object records are returned depends on the query and if access to
|
|
the object is allowed.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the object record for the given object ID if the second parameter
|
|
is an integer.
|
|
</para>
|
|
<para>
|
|
If the second parameter is an array of integer the function will
|
|
return an array of object records. In such a case the last
|
|
parameter is also evaluated which is a query string.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>hw_getandlock</function></member>
|
|
<member><function>hw_getobjectbyquery</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
|
|
-->
|