File: udm-get-res-field.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (133 lines) | stat: -rw-r--r-- 3,643 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
 <refentry id="function.udm-get-res-field">
  <refnamediv>
   <refname>udm_get_res_field</refname>
   <refpurpose>Fetch mnoGoSearch result field</refpurpose>
  </refnamediv>
  
  <refsect1>
   <title>Description</title>
    <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>
    <function>udm_get_res_field</function> returns result field value on 
    success, &false; on error.
   </para>
   
   <para>
    <parameter>res</parameter> - a link to result identifier, received 
    after call to <function>udm_find</function>.
   </para>
   
   <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>
   
   <para>
    <parameter>field</parameter> - field identifier, may have the following values:
   </para>
   
   <itemizedlist>
    <listitem>
     <simpara>
      UDM_FIELD_URL - document URL field
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      UDM_FIELD_CONTENT - document Content-type field (for example, text/html).
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      UDM_FIELD_CATEGORY - 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>
      UDM_FIELD_TITLE - document title field.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      UDM_FIELD_KEYWORDS - document keywords field (from META KEYWORDS tag).
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      UDM_FIELD_DESC - document description field (from META DESCRIPTION tag).
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      UDM_FIELD_TEXT - document body text (the first couple of lines to give an 
      idea of what the document is about).
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      UDM_FIELD_SIZE - document size.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      UDM_FIELD_URLID - unique URL ID of the link.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      UDM_FIELD_RATING  - page rating (as calculated by mnoGoSearch).
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      UDM_FIELD_MODIFIED - last-modified field in unixtime format.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      UDM_FIELD_ORDER - the number of the current document in set of found documents.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      UDM_FIELD_CRC - document CRC.
     </simpara>
    </listitem>
   </itemizedlist>
   
  </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
-->