mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
134 lines
3.2 KiB
XML
134 lines
3.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml: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 role="description">
|
|
&reftitle.description;
|
|
<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>
|
|
Gets all the categories on the same level with the current one.
|
|
</para>
|
|
<para>
|
|
The function can be useful for developing categories tree browser.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>agent</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A link to Agent, received after call to
|
|
<function>udm_alloc_agent</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>category</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an array listing all categories of the same level as the current
|
|
<parameter>category</parameter> in the categories tree.
|
|
</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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>udm_cat_path</function></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|