php-doc-en/reference/mnogosearch/functions/udm-cat-path.xml
2004-07-27 04:48:55 +00:00

89 lines
2.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-cat-path">
<refnamediv>
<refname>udm_cat_path</refname>
<refpurpose>Get the path to the current category</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>udm_cat_path</methodname>
<methodparam><type>resource</type><parameter>agent</parameter></methodparam>
<methodparam><type>string</type><parameter>category</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array describing the path in the categories tree from the tree
root to the current one, specified by <parameter>category</parameter>.
<parameter>agent</parameter> is the agent identifier returned by a previous
call to <function>>udm_alloc_agent</function>.
</para>
<para>
The returned array consists of pairs. Elements with even index numbers
contain the category paths, odd elements contain the corresponding category
names.
</para>
<para>
For example, the call <literal>$array=udm_cat_path($agent, '02031D');</literal>
may return the following array:
<screen>
<![CDATA[
$array[0] will contain ''
$array[1] will contain 'Root'
$array[2] will contain '02'
$array[3] will contain 'Sport'
$array[4] will contain '0203'
$array[5] will contain 'Auto'
$array[4] will contain '02031D'
$array[5] will contain 'Ferrari'
]]>
</screen>
</para>
<para>
<example>
<title>
Specifying path to the current category in the following format:
'&gt; Root &gt; Sport &gt; Auto &gt; Ferrari'
</title>
<programlisting role="php">
<![CDATA[
<?php
$cat_path_arr = udm_cat_path($udm_agent, $cat);
$cat_path = '';
for ($i=0; $i<count($cat_path_arr); $i+=2) {
$path = $cat_path_arr[$i];
$name = $cat_path_arr[$i+1];
$cat_path .= " > <a href=\"$_SERVER[PHP_SELF]?cat=$path\">$name</a> ";
}
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>udm_cat_list</function>.
</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
-->