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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-cat-list">
<refnamediv>
<refname>udm_cat_list</refname>
<refpurpose>Get all the categories on the same level with the current one</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>udm_cat_list</methodname>
<methodparam><type>resource</type><parameter>agent</parameter></methodparam>
<methodparam><type>string</type><parameter>category</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array listing all categories of the same level as the current
<parameter>category</parameter> in the categories tree.
<parameter>agent</parameter> is the agent identifier returned by a previous
call to <function>>udm_alloc_agent</function>.
</para>
<para>
The function can be useful for developing categories tree browser.
</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>
<screen>
<![CDATA[
$array[0] will contain '020300'
$array[1] will contain 'Audi'
$array[2] will contain '020301'
$array[3] will contain 'BMW'
$array[4] will contain '020302'
$array[5] will contain 'Opel'
...
etc.
]]>
</screen>
<para>
Following is an example of displaying links of the current level in format:
<screen>
<![CDATA[
Audi
BMW
Opel
...
]]>
</screen>
<example>
<title><function>udm_cat_list</function>example</title>
<programlisting role="php">
<![CDATA[
<?php
$cat_list_arr = udm_cat_list($udm_agent, $cat);
$cat_list = '';
for ($i=0; $i<count($cat_list_arr); $i+=2) {
$path = $cat_list_arr[$i];
$name = $cat_list_arr[$i+1];
$cat_list .= "<a href=\"$_SERVER[PHP_SELF]?cat=$path\">$name</a><br />";
}
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>udm_cat_path</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
-->
|