CGExtensions 1.53.6

\cge_template_admin

This class provides methods for displaying forms and reports that aide in managing a module's templates.

This class and the appropriate wrapper functions are deprecated. The DesignManger module and it's related classes are better solutions for these functions.

Summary

Methods

Properties

Constants

get_start_template_form()
get_single_template_form()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

get_start_template_form()

get_start_template_form(\CMSModule $module, string $id, int $returnid, string $prefname, string $action, string $active_tab, string $title, string $filename, string $info, bool $simple) : string

Get a form for displaying a 'start' template. A start template is read from a file, stored in the database, and is used when creating a new template of that type.

Parameters

\CMSModule	$module	The module that this template is for
string	$id	The module instance id.
int	$returnid	The returnid (usually empty)
string	$prefname	The preference (relative to the module supplied) that will hold this start template.
string	$action	The return action (usually defaultadmin)
string	$active_tab	The name of the tab to return to.
string	$title	The title for this form. Usually indicates to the administrator what template he is editing.
string	$filename	The file name (relative to the modules templates directory) where the system default version of the 'start' template is.
string	$info	The info string for the form.
bool	$simple	A flag indicating a simple form.

Returns

string —

An HTML form.

\CMSModule	$module	The module that this template is for.
string	$id	The module action id.
int	$returnid	The returnid (usually empty)
string	$tmplname	The template name
string	$active_tab	The active tab name
string	$title	A title for the form, usually indicates which template this form is editing.
string	$filename	The filename (relative to the modules templates directory) of the factory default template source.
string	$info	Optional help for this template
string	$destaction	The destination action (usually defaultadmin)
bool	$simple	whether to output a simple form