php-doc-en/reference/mnogosearch/functions/udm-get-res-field.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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
-->