mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-29 07:18:55 +00:00
c030e2adf7
- All id attributes are now xml:id - Add docbook namespace to all root elements - Replace <ulink /> with <link xlink:href /> - Minor markup fixes here and there git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
112 lines
3.6 KiB
XML
112 lines
3.6 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.5 $ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.udm-find">
|
|
<refnamediv>
|
|
<refname>udm_find</refname>
|
|
<refpurpose>Perform search</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>udm_find</methodname>
|
|
<methodparam><type>resource</type><parameter>agent</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>query</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Performs a search.
|
|
</para>
|
|
<para>
|
|
The search itself. The first argument - session, the next one -
|
|
query itself. To find something just type words you want to find
|
|
and press SUBMIT button. For example, "mysql odbc". You should
|
|
not use quotes " in query, they are written here only to divide a
|
|
query from other text. mnoGoSearch will find all documents that
|
|
contain word "mysql" and/or word "odbc". Best documents having
|
|
bigger weights will be displayed first. If you use search mode
|
|
ALL, search will return documents that contain both (or more)
|
|
words you entered. In case you use mode ANY, the search will
|
|
return list of documents that contain any of the words you
|
|
entered. If you want more advanced results you may use query
|
|
language. You should select "bool" match mode in the search
|
|
from.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>agent</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A link to Agent, received after call to
|
|
<function>udm_alloc_agent</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>query</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
mnoGoSearch understands the following boolean operators:
|
|
</para>
|
|
<para>
|
|
& - logical AND. For example, "mysql &
|
|
odbc". mnoGoSearch will find any URLs that contain both
|
|
"mysql" and "odbc".
|
|
</para>
|
|
<para>
|
|
| - logical OR. For example "mysql|odbc". mnoGoSearch
|
|
will find any URLs, that contain word "mysql" or word
|
|
"odbc".
|
|
</para>
|
|
<para>
|
|
~ - logical NOT. For example "mysql & ~odbc".
|
|
mnoGoSearch will find URLs that contain word "mysql"
|
|
and do not contain word "odbc" at the same time. Note
|
|
that ~ just excludes given word from results. Query
|
|
"~odbc" will find nothing!
|
|
</para>
|
|
<para>
|
|
() - group command to compose more complex queries. For example
|
|
"(mysql | msql) & ~postgres". Query language is
|
|
simple and powerful at the same time. Just consider query as
|
|
usual boolean expression.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a result link identifier on success, or &false; on failure.
|
|
</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
|
|
-->
|