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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.udm-get-res-field">
<refnamediv>
<refname>udm_get_res_field</refname>
<refpurpose>Fetch a result field</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>udm_get_res_field</methodname>
<methodparam><type>resource</type><parameter>res</parameter></methodparam>
<methodparam><type>int</type><parameter>row</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
Fetch a mnoGoSearch result field.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>res</parameter></term>
<listitem>
<para>
<parameter>res</parameter> - a link to result identifier, received
after call to <function>udm_find</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>row</parameter></term>
<listitem>
<para>
<parameter>row</parameter> - the number of the link on the current page.
May have values from 0 to
<parameter>UDM_PARAM_NUM_ROWS-1</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>
<para>
<parameter>field</parameter> - field identifier, may have the following values:
<itemizedlist>
<listitem>
<simpara>
<constant>UDM_FIELD_URL</constant> - document URL field
</simpara>
</listitem>
<listitem>
<simpara>
<constant>UDM_FIELD_CONTENT</constant> - document
<literal>Content-type</literal> field (for example, <literal>text/html</literal>).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>UDM_FIELD_CATEGORY</constant> - document category field. Use
<function>udm_cat_path</function> to get full path to current category
from the categories tree root. (This parameter is available only in PHP
4.0.6 or later).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>UDM_FIELD_TITLE</constant> - document title field.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>UDM_FIELD_KEYWORDS</constant> - document keywords field (from META KEYWORDS tag).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>UDM_FIELD_DESC</constant> - document description field (from META DESCRIPTION tag).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>UDM_FIELD_TEXT</constant> - document body text (the first couple of lines to give an
idea of what the document is about).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>UDM_FIELD_SIZE</constant> - document size.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>UDM_FIELD_URLID</constant> - unique URL ID of the link.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>UDM_FIELD_RATING</constant> - page rating (as calculated by mnoGoSearch).
</simpara>
</listitem>
<listitem>
<simpara>
<constant>UDM_FIELD_MODIFIED</constant> - last-modified field in unixtime format.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>UDM_FIELD_ORDER</constant> - the number of the current document in set of found documents.
</simpara>
</listitem>
<listitem>
<simpara>
<constant>UDM_FIELD_CRC</constant> - document CRC.
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>udm_get_res_field</function> returns result field value on
success, &false; on error.
</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
-->
|
