Cpanel::UI::dynamicincludelist

This article documents the usage of the Cpanel::UI::dynamicincludelist function in relation to the cPanel interface. This tag can be used inside cPanel pages.


SYNOPSIS

Cpanel::UI::dynamicincludelist


DESCRIPTION

DEPRECATED, DO NOT USE. Use Branding::applist instead.


VARIABLES

INPUT

arglist (string)
List of cell order. Any *.html in cells/ is available.
basedir (string)
Base directory for the location of cell files. Default: cells
nvarglist (string)
Non-volatile data store list of cell order.

OUTPUT

cell (string)
Name of a cell.


EXAMPLES

<!?cp UI::dynamicincludelist([script]preregister_section\{leftparenthesis}'%'\{rightparenthesis};[/script],cell) basedir=cells,arglist=mail|logs|files|domains|db|sec|software|pref|advanced,nvarglist=$NVDATA{'xmaingroupsorder'} ?>

This example outputs the list of included cells for the main screen of cPanel X3. It will output the cell names in the order specifiied in arglist=. It also uses the nvarglist variable to draw the order from the stored ``xmaingorupsorder'' key in the user's .nvdata directory. In this example, the cell list is passed to a javascript function for processing.


COPYRIGHT

Copyright 2007 cPanel Inc.