| Current Path : /webspace/www.babilon.be/html/modules/CGExtensions/docs/apidoc/classes/ |
| Current File : //webspace/www.babilon.be/html/modules/CGExtensions/docs/apidoc/classes/CGExtensions.html |
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
<meta charset="utf-8"/>
<title>CGExtensions 1.45</title>
<meta name="author" content=""/>
<meta name="description" content=""/>
<link href="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
<link href="https://netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.min.css" rel="stylesheet">
<link href="../css/prism.css" rel="stylesheet" media="all"/>
<link href="../css/template.css" rel="stylesheet" media="all"/>
<!--[if lt IE 9]>
<script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
<![endif]-->
<script src="https://code.jquery.com/jquery-1.10.2.min.js" type="text/javascript"></script>
<script src="https://code.jquery.com/ui/1.10.3/jquery-ui.min.js" type="text/javascript"></script>
<script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script>
<script src="../js/jquery.smooth-scroll.js"></script>
<script src="../js/prism.min.js"></script>
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
<script type="text/javascript">
function loadExternalCodeSnippets() {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
var src = pre.getAttribute('data-src');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist or is empty';
}
}
};
xhr.send(null);
});
}
$(document).ready(function(){
loadExternalCodeSnippets();
});
$('#source-view').on('shown', function () {
loadExternalCodeSnippets();
})
</script>
<link rel="shortcut icon" href="../images/favicon.ico"/>
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
<link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<i class="icon-ellipsis-vertical"></i>
</a>
<a class="brand" href="../index.html">CGExtensions 1.45</a>
<div class="nav-collapse">
<ul class="nav pull-right">
<li class="dropdown">
<a href="../index.html" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="../namespaces/CGExtensions.html">\CGExtensions</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../graphs/class.html">
<i class="icon-list-alt"></i> Class hierarchy diagram
</a>
</li>
</ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">93</span>
</a>
</li>
<li>
<a href="../reports/markers.html">
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">0</span>
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<!--<div class="go_to_top">-->
<!--<a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a>-->
<!--</div>-->
</div>
<div id="___" class="container-fluid">
<section class="row-fluid">
<div class="span2 sidebar">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-385044334"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-385044334" class="accordion-body collapse in">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1274897138"></a>
<a href="../namespaces/CGExtensions.html" style="margin-left: 30px; padding-left: 0">CGExtensions</a>
</div>
<div id="namespace-1274897138" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1611083766"></a>
<a href="../namespaces/CGExtensions.query.html" style="margin-left: 30px; padding-left: 0">query</a>
</div>
<div id="namespace-1611083766" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/CGExtensions.query.resultset.html">resultset</a></li>
<li class="class"><a href="../classes/CGExtensions.query.sql_resultset.html">sql_resultset</a></li>
<li class="class"><a href="../classes/CGExtensions.query.csvfileresultset.html">csvfileresultset</a></li>
<li class="class"><a href="../classes/CGExtensions.query.pagination.html">pagination</a></li>
<li class="class"><a href="../classes/CGExtensions.query.sql_query.html">sql_query</a></li>
<li class="class"><a href="../classes/CGExtensions.query.txtfileresultset.html">txtfileresultset</a></li>
<li class="class"><a href="../classes/CGExtensions.query.query.html">query</a></li>
<li class="class"><a href="../classes/CGExtensions.query.csvfilequery.html">csvfilequery</a></li>
<li class="class"><a href="../classes/CGExtensions.query.txtfilequery.html">txtfilequery</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-2109993185"></a>
<a href="../namespaces/CGExtensions.reports.html" style="margin-left: 30px; padding-left: 0">reports</a>
</div>
<div id="namespace-2109993185" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/CGExtensions.reports.template_report_generator.html">template_report_generator</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.html_report_generator.html">html_report_generator</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.report_defn.html">report_defn</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.tabular_report_generator.html">tabular_report_generator</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.tabular_report_defn.html">tabular_report_defn</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.tabular_report_cellfmt.html">tabular_report_cellfmt</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.tabular_report_defn_column.html">tabular_report_defn_column</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.tabular_report_defn_group.html">tabular_report_defn_group</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.tabular_report_defn_group_line.html">tabular_report_defn_group_line</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.data_report_generator.html">data_report_generator</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.text_report_generator.html">text_report_generator</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.formatted_report_generator.html">formatted_report_generator</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.report_generator.html">report_generator</a></li>
<li class="class"><a href="../classes/CGExtensions.reports.formatted_report_defn.html">formatted_report_defn</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-568924981"></a>
<a href="../namespaces/CGExtensions.LinkDefinition.html" style="margin-left: 30px; padding-left: 0">LinkDefinition</a>
</div>
<div id="namespace-568924981" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="interface"><a href="../classes/CGExtensions.LinkDefinition.LinkDefinitionGenerator.html">LinkDefinitionGenerator</a></li>
<li class="class"><a href="../classes/CGExtensions.LinkDefinition.LinkDefinitionGeneratorFactory.html">LinkDefinitionGeneratorFactory</a></li>
<li class="class"><a href="../classes/CGExtensions.LinkDefinition.CoreLinkDefinitionGenerator.html">CoreLinkDefinitionGenerator</a></li>
<li class="class"><a href="../classes/CGExtensions.LinkDefinition.DataRef.html">DataRef</a></li>
<li class="class"><a href="../classes/CGExtensions.LinkDefinition.LinkDefinition.html">LinkDefinition</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-981620901"></a>
<a href="../namespaces/CGExtensions.jsloader.html" style="margin-left: 30px; padding-left: 0">jsloader</a>
</div>
<div id="namespace-981620901" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/CGExtensions.jsloader.libdefn.html">libdefn</a></li>
<li class="class"><a href="../classes/CGExtensions.jsloader.jsloader.html">jsloader</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
<li class="class"><a href="../classes/CGExtensions.content_list_builder.html">content_list_builder</a></li>
<li class="class"><a href="../classes/CGExtensions.wm_exception.html">wm_exception</a></li>
<li class="class"><a href="../classes/CGExtensions.watermarker.html">watermarker</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
<li class="class"><a href="../classes/cge_dir.html">cge_dir</a></li>
<li class="class"><a href="../classes/cge_redirect.html">cge_redirect</a></li>
<li class="class"><a href="../classes/cge_http.html">cge_http</a></li>
<li class="class"><a href="../classes/cge_singleton.html">cge_singleton</a></li>
<li class="class"><a href="../classes/cge_address.html">cge_address</a></li>
<li class="class"><a href="../classes/cge_setup.html">cge_setup</a></li>
<li class="class"><a href="../classes/cms_cache_handler.html">cms_cache_handler</a></li>
<li class="class"><a href="../classes/cge_url.html">cge_url</a></li>
<li class="class"><a href="../classes/cg_fileupload.html">cg_fileupload</a></li>
<li class="class"><a href="../classes/cge_template_admin.html">cge_template_admin</a></li>
<li class="class"><a href="../classes/cg_watermark.html">cg_watermark</a></li>
<li class="class"><a href="../classes/cge_debug.html">cge_debug</a></li>
<li class="class"><a href="../classes/CGExtensions.html">CGExtensions</a></li>
<li class="class"><a href="../classes/cg_exception.html">cg_exception</a></li>
<li class="class"><a href="../classes/cms_filecache_driver.html">cms_filecache_driver</a></li>
<li class="class"><a href="../classes/cge_cached_remote_file.html">cge_cached_remote_file</a></li>
<li class="class"><a href="../classes/friendly.html">friendly</a></li>
<li class="class"><a href="../classes/cge_utils.html">cge_utils</a></li>
<li class="class"><a href="../classes/cge_image.html">cge_image</a></li>
<li class="class"><a href="../classes/cge_browser.html">cge_browser</a></li>
<li class="class"><a href="../classes/cge_uploader.html">cge_uploader</a></li>
<li class="class"><a href="../classes/cge_tags.html">cge_tags</a></li>
<li class="class"><a href="../classes/cge_encrypt.html">cge_encrypt</a></li>
<li class="class"><a href="../classes/cge_datastore.html">cge_datastore</a></li>
<li class="class"><a href="../classes/cge_userops.html">cge_userops</a></li>
<li class="class"><a href="../classes/cge_template_utils.html">cge_template_utils</a></li>
<li class="class"><a href="../classes/cge_tmpdata.html">cge_tmpdata</a></li>
<li class="class"><a href="../classes/cge_units.html">cge_units</a></li>
<li class="class"><a href="../classes/module_helper.html">module_helper</a></li>
<li class="class"><a href="../classes/cms_cache_driver.html">cms_cache_driver</a></li>
<li class="class"><a href="../classes/cge_string.html">cge_string</a></li>
<li class="class"><a href="../classes/cge_date.html">cge_date</a></li>
<li class="class"><a href="../classes/cge_headers.html">cge_headers</a></li>
<li class="class"><a href="../classes/notification_message.html">notification_message</a></li>
<li class="class"><a href="../classes/cge_smartcache_handler.html">cge_smartcache_handler</a></li>
<li class="class"><a href="../classes/AssocDataNode.html">AssocDataNode</a></li>
<li class="class"><a href="../classes/AssocData.html">AssocData</a></li>
<li class="class"><a href="../classes/cge_message.html">cge_message</a></li>
<li class="class"><a href="../classes/encrypted_store.html">encrypted_store</a></li>
<li class="class"><a href="../classes/cg_db_exception.html">cg_db_exception</a></li>
<li class="class"><a href="../classes/cg_sql_error.html">cg_sql_error</a></li>
<li class="class"><a href="../classes/cg_InvalidDataException.html">cg_InvalidDataException</a></li>
<li class="class"><a href="../classes/cg_notfoundException.html">cg_notfoundException</a></li>
<li class="class"><a href="../classes/cge_session.html">cge_session</a></li>
<li class="class"><a href="../classes/cge_date_utils.html">cge_date_utils</a></li>
<li class="class"><a href="../classes/cge_array.html">cge_array</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
</section>
<section class="row-fluid">
<div class="span10 offset2">
<div class="row-fluid">
<div class="span8 content class">
<nav>
<a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i>
</nav>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
<h1><small>\</small>CGExtensions</h1>
<p><em>A base class for all CMSMS modules written by me to provide optimizations and
conveniences that are not built into CMSMS.</em></p>
<section id="summary">
<h2>Summary</h2>
<section class="row-fluid heading">
<section class="span4">
<a href="#methods">Methods</a>
</section>
<section class="span4">
<a href="#properties">Properties</a>
</section>
<section class="span4">
<a href="#constants">Constants</a>
</section>
</section>
<section class="row-fluid public">
<section class="span4">
<a href="../classes/CGExtensions.html#method___construct" class="">__construct()</a><br />
<a href="../classes/CGExtensions.html#method_SetParameters" class="deprecated">SetParameters()</a><br />
<a href="../classes/CGExtensions.html#method_GetFriendlyName" class="">GetFriendlyName()</a><br />
<a href="../classes/CGExtensions.html#method_GetVersion" class="">GetVersion()</a><br />
<a href="../classes/CGExtensions.html#method_GetHelp" class="">GetHelp()</a><br />
<a href="../classes/CGExtensions.html#method_GetAuthor" class="">GetAuthor()</a><br />
<a href="../classes/CGExtensions.html#method_GetAuthorEmail" class="">GetAuthorEmail()</a><br />
<a href="../classes/CGExtensions.html#method_GetChangeLog" class="">GetChangeLog()</a><br />
<a href="../classes/CGExtensions.html#method_IsPluginModule" class="">IsPluginModule()</a><br />
<a href="../classes/CGExtensions.html#method_HasAdmin" class="">HasAdmin()</a><br />
<a href="../classes/CGExtensions.html#method_HandlesEvents" class="">HandlesEvents()</a><br />
<a href="../classes/CGExtensions.html#method_GetAdminSection" class="">GetAdminSection()</a><br />
<a href="../classes/CGExtensions.html#method_GetAdminDescription" class="">GetAdminDescription()</a><br />
<a href="../classes/CGExtensions.html#method_GetDependencies" class="">GetDependencies()</a><br />
<a href="../classes/CGExtensions.html#method_InstallPostMessage" class="">InstallPostMessage()</a><br />
<a href="../classes/CGExtensions.html#method_MinimumCMSVersion" class="">MinimumCMSVersion()</a><br />
<a href="../classes/CGExtensions.html#method_UninstallPostMessage" class="">UninstallPostMessage()</a><br />
<a href="../classes/CGExtensions.html#method_VisibleToAdminUser" class="">VisibleToAdminUser()</a><br />
<a href="../classes/CGExtensions.html#method_GetHeaderHTML" class="">GetHeaderHTML()</a><br />
<a href="../classes/CGExtensions.html#method_DoAction" class="">DoAction()</a><br />
<a href="../classes/CGExtensions.html#method_encrypt" class="">encrypt()</a><br />
<a href="../classes/CGExtensions.html#method_decrypt" class="">decrypt()</a><br />
<a href="../classes/CGExtensions.html#method_CreateURL" class="deprecated">CreateURL()</a><br />
<a href="../classes/CGExtensions.html#method_CreateSortableListArea" class="deprecated">CreateSortableListArea()</a><br />
<a href="../classes/CGExtensions.html#method_CreateInputYesNoDropdown" class="deprecated">CreateInputYesNoDropdown()</a><br />
<a href="../classes/CGExtensions.html#method_CGCreateInputSubmit" class="deprecated">CGCreateInputSubmit()</a><br />
<a href="../classes/CGExtensions.html#method_CreateInputCheckbox" class="deprecated">CreateInputCheckbox()</a><br />
<a href="../classes/CGExtensions.html#method_CGCreateFormStart" class="deprecated">CGCreateFormStart()</a><br />
<a href="../classes/CGExtensions.html#method_CGCreateFrontendFormStart" class="deprecated">CGCreateFrontendFormStart()</a><br />
<a href="../classes/CGExtensions.html#method_CreateInputHidden" class="deprecated">CreateInputHidden()</a><br />
<a href="../classes/CGExtensions.html#method_RedirectToTab" class="">RedirectToTab()</a><br />
<a href="../classes/CGExtensions.html#method_Redirect" class="">Redirect()</a><br />
<a href="../classes/CGExtensions.html#method_IsAdminAction" class="">IsAdminAction()</a><br />
<a href="../classes/CGExtensions.html#method_SetError" class="">SetError()</a><br />
<a href="../classes/CGExtensions.html#method_SetMessage" class="">SetMessage()</a><br />
<a href="../classes/CGExtensions.html#method_DisplayErrors" class="">DisplayErrors()</a><br />
<a href="../classes/CGExtensions.html#method_DisplayMessages" class="">DisplayMessages()</a><br />
<a href="../classes/CGExtensions.html#method_SetCurrentAction" class="">SetCurrentAction()</a><br />
<a href="../classes/CGExtensions.html#method_SetCurrentTab" class="">SetCurrentTab()</a><br />
<a href="../classes/CGExtensions.html#method_SetTabHeader" class="">SetTabHeader()</a><br />
<a href="../classes/CGExtensions.html#method_DisplayErrorMessage" class="deprecated">DisplayErrorMessage()</a><br />
<a href="../classes/CGExtensions.html#method_GetErrorTemplate" class="deprecated">GetErrorTemplate()</a><br />
<a href="../classes/CGExtensions.html#method_ResetErrorTemplate" class="deprecated">ResetErrorTemplate()</a><br />
<a href="../classes/CGExtensions.html#method_SetErrorTemplate" class="deprecated">SetErrorTemplate()</a><br />
<a href="../classes/CGExtensions.html#method_CreateInputStateDropdown" class="deprecated">CreateInputStateDropdown()</a><br />
<a href="../classes/CGExtensions.html#method_CreateInputCountryDropdown" class="deprecated">CreateInputCountryDropdown()</a><br />
<a href="../classes/CGExtensions.html#method_GetCountry" class="">GetCountry()</a><br />
<a href="../classes/CGExtensions.html#method_GetState" class="">GetState()</a><br />
<a href="../classes/CGExtensions.html#method_CreateImageDropdown" class="deprecated">CreateImageDropdown()</a><br />
<a href="../classes/CGExtensions.html#method_CreateFileDropdown" class="deprecated">CreateFileDropdown()</a><br />
<a href="../classes/CGExtensions.html#method_CreateColorDropdown" class="deprecated">CreateColorDropdown()</a><br />
<a href="../classes/CGExtensions.html#method_CreateImageTag" class="deprecated">CreateImageTag()</a><br />
<a href="../classes/CGExtensions.html#method_DisplayImage" class="deprecated">DisplayImage()</a><br />
<a href="../classes/CGExtensions.html#method_CreateImageLink" class="deprecated">CreateImageLink()</a><br />
<a href="../classes/CGExtensions.html#method_AddImageDir" class="">AddImageDir()</a><br />
<a href="../classes/CGExtensions.html#method_ListTemplatesWithPrefix" class="deprecated">ListTemplatesWithPrefix()</a><br />
<a href="../classes/CGExtensions.html#method_CreateTemplateDropdown" class="deprecated">CreateTemplateDropdown()</a><br />
<a href="../classes/CGExtensions.html#method_ShowTemplateList" class="deprecated">ShowTemplateList()</a><br />
<a href="../classes/CGExtensions.html#method_GetDefaultTemplateForm" class="deprecated">GetDefaultTemplateForm()</a><br />
<a href="../classes/CGExtensions.html#method_EditDefaultTemplateForm" class="deprecated">EditDefaultTemplateForm()</a><br />
<a href="../classes/CGExtensions.html#method_CreateContentURL" class="">CreateContentURL()</a><br />
<a href="../classes/CGExtensions.html#method_GetAdminUsername" class="deprecated">GetAdminUsername()</a><br />
<a href="../classes/CGExtensions.html#method_GetUploadErrorMessage" class="deprecated">GetUploadErrorMessage()</a><br />
<a href="../classes/CGExtensions.html#method_GetSingleTemplateForm" class="deprecated">GetSingleTemplateForm()</a><br />
<a href="../classes/CGExtensions.html#method_GetWatermarkError" class="deprecated">GetWatermarkError()</a><br />
<a href="../classes/CGExtensions.html#method_InitializeCharting" class="deprecated">InitializeCharting()</a><br />
<a href="../classes/CGExtensions.html#method_InitializeAssocData" class="deprecated">InitializeAssocData()</a><br />
<a href="../classes/CGExtensions.html#method_session_clear" class="">session_clear()</a><br />
<a href="../classes/CGExtensions.html#method_session_put" class="">session_put()</a><br />
<a href="../classes/CGExtensions.html#method_session_get" class="">session_get()</a><br />
<a href="../classes/CGExtensions.html#method_param_session_get" class="">param_session_get()</a><br />
<a href="../classes/CGExtensions.html#method_resolve_alias_or_id" class="">resolve_alias_or_id()</a><br />
<a href="../classes/CGExtensions.html#method_http_post" class="">http_post()</a><br />
<a href="../classes/CGExtensions.html#method_http_get" class="">http_get()</a><br />
<a href="../classes/CGExtensions.html#method_CGGetPreference" class="">CGGetPreference()</a><br />
<a href="../classes/CGExtensions.html#method_CGGetUserPreference" class="">CGGetUserPreference()</a><br />
<a href="../classes/CGExtensions.html#method_CGSetUserPreference" class="">CGSetUserPreference()</a><br />
<a href="../classes/CGExtensions.html#method_CGRemoveUserPreference" class="">CGRemoveUserPreference()</a><br />
<a href="../classes/CGExtensions.html#method_find_file" class="">find_file()</a><br />
<a href="../classes/CGExtensions.html#method_CGGetTemplateResource" class="">CGGetTemplateResource()</a><br />
<a href="../classes/CGExtensions.html#method_CGProcessTemplate" class="">CGProcessTemplate()</a><br />
<a href="../classes/CGExtensions.html#method_GetActionModule" class="">GetActionModule()</a><br />
</section>
<section class="span4">
<em>No public properties found</em>
</section>
<section class="span4">
<em>No constants found</em>
</section>
</section>
<section class="row-fluid protected">
<section class="span4">
<a href="../classes/CGExtensions.html#method_get_state_list" class="">get_state_list()</a><br />
<a href="../classes/CGExtensions.html#method_get_state_list_options" class="">get_state_list_options()</a><br />
<a href="../classes/CGExtensions.html#method_get_country_list" class="">get_country_list()</a><br />
<a href="../classes/CGExtensions.html#method_get_country_list_options" class="">get_country_list_options()</a><br />
</section>
<section class="span4">
<em>No protected properties found</em>
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
<section class="row-fluid private">
<section class="span4">
<em>No private methods found</em>
</section>
<section class="span4">
<em>No private properties found</em>
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
</section>
</div>
<aside class="span4 detailsbar">
<dl>
<dt>File</dt>
<dd><a href="../files/CGExtensions.module.php.html"><div class="path-wrapper">CGExtensions.module.php</div></a></dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">\CGExtensions</div></dd>
<dt>Class hierarchy</dt>
<dd class="hierarchy">
<div class="namespace-wrapper">\CMSModule</div>
<div class="namespace-wrapper">\CGExtensions</div>
</dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<a id="methods" name="methods"></a>
<div class="row-fluid">
<div class="span8 content class"><h2>Methods</h2></div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method___construct" name="method___construct" class="anchor"></a>
<article class="method">
<h3 class="public ">__construct()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">__construct()</pre>
<p><em>The constructor.</em></p>
<p>This method does numerous things, including setup an extended autoloader,
create defines for the module itself. i.e: MOD_CGEXTENSIONS, or MOD_FRONTENDUSERS.
sets up a built in cache driver for temporarily caching data.
and register numerous smarty plugins (see the documentation for those).</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_SetParameters" name="method_SetParameters" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">SetParameters()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">SetParameters()</pre>
<p><em>Set parameters for this module.</em></p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetFriendlyName" name="method_GetFriendlyName" class="anchor"></a>
<article class="method">
<h3 class="public ">GetFriendlyName()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetFriendlyName() : string</pre>
<p><em>The Friendly name for this module. For use in the admin navigation.</em></p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetVersion" name="method_GetVersion" class="anchor"></a>
<article class="method">
<h3 class="public ">GetVersion()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetVersion() : string</pre>
<p><em>Return the version of this module.</em></p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetHelp" name="method_GetHelp" class="anchor"></a>
<article class="method">
<h3 class="public ">GetHelp()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetHelp() : string</pre>
<p><em>Return the help of this module.</em></p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetAuthor" name="method_GetAuthor" class="anchor"></a>
<article class="method">
<h3 class="public ">GetAuthor()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetAuthor() : string</pre>
<p><em>Return the Author of this module.</em></p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetAuthorEmail" name="method_GetAuthorEmail" class="anchor"></a>
<article class="method">
<h3 class="public ">GetAuthorEmail()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetAuthorEmail() : string</pre>
<p><em>Return the email address for the author of this module.</em></p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetChangeLog" name="method_GetChangeLog" class="anchor"></a>
<article class="method">
<h3 class="public ">GetChangeLog()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetChangeLog() : string</pre>
<p><em>Return the changelog for this module.</em></p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_IsPluginModule" name="method_IsPluginModule" class="anchor"></a>
<article class="method">
<h3 class="public ">IsPluginModule()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">IsPluginModule() : bool</pre>
<p><em>Return if this is a plugin module (for the frontend of the website) or not.</em></p>
<h4>Returns</h4>
bool
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_HasAdmin" name="method_HasAdmin" class="anchor"></a>
<article class="method">
<h3 class="public ">HasAdmin()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">HasAdmin() : string</pre>
<p><em>Return if this module has an admin section.</em></p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_HandlesEvents" name="method_HandlesEvents" class="anchor"></a>
<article class="method">
<h3 class="public ">HandlesEvents()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">HandlesEvents() : string</pre>
<p><em>Return if this module handles events.</em></p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetAdminSection" name="method_GetAdminSection" class="anchor"></a>
<article class="method">
<h3 class="public ">GetAdminSection()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetAdminSection() : string</pre>
<p><em>Get the section of the admin navigation that this module belongs to.</em></p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetAdminDescription" name="method_GetAdminDescription" class="anchor"></a>
<article class="method">
<h3 class="public ">GetAdminDescription()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetAdminDescription() : string</pre>
<p><em>Get a human readable description for this module.</em></p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetDependencies" name="method_GetDependencies" class="anchor"></a>
<article class="method">
<h3 class="public ">GetDependencies()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetDependencies() : string</pre>
<p><em>Get a hash containing dependent modules, and their minimum versions.</em></p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_InstallPostMessage" name="method_InstallPostMessage" class="anchor"></a>
<article class="method">
<h3 class="public ">InstallPostMessage()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">InstallPostMessage() : string</pre>
<p><em>Display a custom message after the module has been installed.</em></p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_MinimumCMSVersion" name="method_MinimumCMSVersion" class="anchor"></a>
<article class="method">
<h3 class="public ">MinimumCMSVersion()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">MinimumCMSVersion() : string</pre>
<p><em>Return the minimum CMSMS version that this module is compatible with.</em></p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_UninstallPostMessage" name="method_UninstallPostMessage" class="anchor"></a>
<article class="method">
<h3 class="public ">UninstallPostMessage()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">UninstallPostMessage() : string</pre>
<p><em>Return a message to display after the module has been uninstalled.</em></p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_VisibleToAdminUser" name="method_VisibleToAdminUser" class="anchor"></a>
<article class="method">
<h3 class="public ">VisibleToAdminUser()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">VisibleToAdminUser() : bool</pre>
<p><em>Test if this module is visible in the admin navigation to the currently logged in admin user.</em></p>
<h4>Returns</h4>
bool
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetHeaderHTML" name="method_GetHeaderHTML" class="anchor"></a>
<article class="method">
<h3 class="public ">GetHeaderHTML()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetHeaderHTML() : bool</pre>
<p><em>Retrieve some HTML to be output in all admin requests for this module (and its descendants).</em></p>
<p>By default this module calls the jsloader::render method, and includes some standard styles</p>
<h4>Returns</h4>
bool
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_DoAction" name="method_DoAction" class="anchor"></a>
<article class="method">
<h3 class="public ">DoAction()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">DoAction(string <span class="argument">$name</span>, string <span class="argument">$id</span>, array <span class="argument">$params</span>, int <span class="argument">$returnid</span>)</pre>
<p><em>A replacement for the built in DoAction method
For CGExtensions derived modules some builtin smarty variables are created
module hints are handled, and input type=image values are corrected in input parameters.</em></p>
<p>this method also handles setting the active tab, and displaying any messages or errors
set with the SetError or SetMessage methods.</p>
<p>This method is called automatically by the system based on the incoming request, and the page template.
It should almost never be called manually.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$name</td>
<td><p>the action name</p></td>
</tr>
<tr>
<td>string</td>
<td>$id</td>
<td><p>The module action id</p></td>
</tr>
<tr>
<td>array</td>
<td>$params</td>
<td><p>The module parameters</p></td>
</tr>
<tr>
<td>int</td>
<td>$returnid</td>
<td><p>The page that will contain the HTML results. This is empty for admin requests.</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_encrypt" name="method_encrypt" class="anchor"></a>
<article class="method">
<h3 class="public ">encrypt()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">encrypt(string <span class="argument">$key</span>, string <span class="argument">$data</span>) : string</pre>
<p><em>A convenience method to encrypt some data</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$key</td>
<td><p>The encryption key</p></td>
</tr>
<tr>
<td>string</td>
<td>$data</td>
<td><p>The data to encrypt</p></td>
</tr>
</table>
<h4>Returns</h4>
string
— <p>The encrypted data</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="../classes/cge_encrypt.html"><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_decrypt" name="method_decrypt" class="anchor"></a>
<article class="method">
<h3 class="public ">decrypt()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">decrypt(string <span class="argument">$key</span>, string <span class="argument">$data</span>) : string</pre>
<p><em>A convenience method to decrypt some data</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$key</td>
<td><p>The encryption key</p></td>
</tr>
<tr>
<td>string</td>
<td>$data</td>
<td><p>The data to decrypt</p></td>
</tr>
</table>
<h4>Returns</h4>
string
— <p>The derypted data</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="../classes/cge_encrypt.html"><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CreateURL" name="method_CreateURL" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">CreateURL()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CreateURL(string <span class="argument">$id</span>, string <span class="argument">$action</span>, string <span class="argument">$returnid</span>, array <span class="argument">$params</span>, bool <span class="argument">$inline</span>, string <span class="argument">$prettyurl</span>)</pre>
<p><em>A convenience function to create a url for a module action.</em></p>
<p>This method is deprecated as the CMSModule::create_url method replaces it.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>the module action id</p></td>
</tr>
<tr>
<td>string</td>
<td>$action</td>
<td><p>The module action</p></td>
</tr>
<tr>
<td>string</td>
<td>$returnid</td>
<td><p>The page that the url will refer to. This is empty for admin requests</p></td>
</tr>
<tr>
<td>array</td>
<td>$params</td>
<td><p>Module parameters</p></td>
</tr>
<tr>
<td>bool</td>
<td>$inline</td>
<td><p>For frontend requests only dicates wether this url should be inline only.</p></td>
</tr>
<tr>
<td>string</td>
<td>$prettyurl</td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CreateSortableListArea" name="method_CreateSortableListArea" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">CreateSortableListArea()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CreateSortableListArea(string <span class="argument">$id</span>, string <span class="argument">$name</span>, array <span class="argument">$items</span>, string <span class="argument">$selected</span>, bool <span class="argument">$allowduplicates</span>, int <span class="argument">$max_selected</span>, string <span class="argument">$template</span>, string <span class="argument">$label_left</span>, string <span class="argument">$label_right</span>) : string</pre>
<p><em>A convenience method to create a control that contains a 'sortable list'.</em></p>
<p>The output control is translated, and interactive and suitable for use in forms.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>The module action id</p></td>
</tr>
<tr>
<td>string</td>
<td>$name</td>
<td><p>The input element name</p></td>
</tr>
<tr>
<td>array</td>
<td>$items</td>
<td><p>An associative array of the items for this list.</p></td>
</tr>
<tr>
<td>string</td>
<td>$selected</td>
<td><p>A comma separated string of selected item keys</p></td>
</tr>
<tr>
<td>bool</td>
<td>$allowduplicates</td>
<td></td>
</tr>
<tr>
<td>int</td>
<td>$max_selected</td>
<td><p>The maximum number of items that can be selected</p></td>
</tr>
<tr>
<td>string</td>
<td>$template</td>
<td><p>Specify an alternate template for the sortable list control</p></td>
</tr>
<tr>
<td>string</td>
<td>$label_left</td>
<td><p>A label for the left column.</p></td>
</tr>
<tr>
<td>string</td>
<td>$label_right</td>
<td><p>A label for the right column.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CreateInputYesNoDropdown" name="method_CreateInputYesNoDropdown" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">CreateInputYesNoDropdown()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CreateInputYesNoDropdown(string <span class="argument">$id</span>, string <span class="argument">$name</span>, int <span class="argument">$selectedvalue</span>, string <span class="argument">$addtext</span>) : string</pre>
<p><em>Create a translated Yes/No dropdown.</em></p>
<p>The output control is translated, and suitable for use in forms.
This method is deprecated. It is best to assign all data to smarty and then create input elements as necessary in the smarty template.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>the module action id</p></td>
</tr>
<tr>
<td>string</td>
<td>$name</td>
<td><p>The name for the input element</p></td>
</tr>
<tr>
<td>int</td>
<td>$selectedvalue</td>
<td><p>The selected value (0 == no, 1 == yes)</p></td>
</tr>
<tr>
<td>string</td>
<td>$addtext</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CGCreateInputSubmit" name="method_CGCreateInputSubmit" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">CGCreateInputSubmit()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CGCreateInputSubmit(string <span class="argument">$id</span>, string <span class="argument">$name</span>, string <span class="argument">$value</span>, string <span class="argument">$addtext</span>, string <span class="argument">$image</span>, string <span class="argument">$confirmtext</span>, string <span class="argument">$class</span>) : string</pre>
<p><em>Create a custom submit button.</em></p>
<p>The output control is translated, and suitable for use in forms.
This method is deprecated. It is best to assign all data to smarty and then create input elements as necessary in the smarty template.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>the module action id</p></td>
</tr>
<tr>
<td>string</td>
<td>$name</td>
<td><p>The name for the input element</p></td>
</tr>
<tr>
<td>string</td>
<td>$value</td>
<td><p>The value for the submit button</p></td>
</tr>
<tr>
<td>string</td>
<td>$addtext</td>
<td><p>Additional text for the tag</p></td>
</tr>
<tr>
<td>string</td>
<td>$image</td>
<td><p>an optional image path</p></td>
</tr>
<tr>
<td>string</td>
<td>$confirmtext</td>
<td><p>Optional confirmation text</p></td>
</tr>
<tr>
<td>string</td>
<td>$class</td>
<td><p>Optional value for the class attribute</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CreateInputCheckbox" name="method_CreateInputCheckbox" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">CreateInputCheckbox()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CreateInputCheckbox(string <span class="argument">$id</span>, string <span class="argument">$name</span>, string <span class="argument">$value</span>, string <span class="argument">$selectedvalue</span>, string <span class="argument">$addtext</span>) : string</pre>
<p><em>Create a custom checkbox.</em></p>
<p>This is similar to the standard checkbox but has a hidden field with the same name
before it so that some value for this field is always returned to the form handler.
This method is deprecated. It is best to assign all data to smarty and then create input elements as necessary in the smarty template.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>the module action id</p></td>
</tr>
<tr>
<td>string</td>
<td>$name</td>
<td><p>The name for the input element</p></td>
</tr>
<tr>
<td>string</td>
<td>$value</td>
<td><p>The value for the checkbox</p></td>
</tr>
<tr>
<td>string</td>
<td>$selectedvalue</td>
<td><p>The current value of the field.</p></td>
</tr>
<tr>
<td>string</td>
<td>$addtext</td>
<td><p>Additional text for the tag</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CGCreateFormStart" name="method_CGCreateFormStart" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">CGCreateFormStart()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CGCreateFormStart(string <span class="argument">$id</span>, string <span class="argument">$action</span>, string <span class="argument">$returnid</span>, array <span class="argument">$params</span>, bool <span class="argument">$inline</span>, string <span class="argument">$method</span>, string <span class="argument">$enctype</span>, string <span class="argument">$idsuffix</span>, string <span class="argument">$extra</span>) : string</pre>
<p><em>A Convenience function for creating form tags.</em></p>
<p>This method re-organises some of the parameters of the original CreateFormStart method
and handles current tab functionalty, and sets the encoding type of the form to multipart/form-data</p>
<p>This method is deprecated and will be replaced in CMSMS 2.0 by the core {form_start} tag.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>the module action id</p></td>
</tr>
<tr>
<td>string</td>
<td>$action</td>
<td><p>the destination action</p></td>
</tr>
<tr>
<td>string</td>
<td>$returnid</td>
<td><p>The destination pagpe for the action handler. Empty for admin requests</p></td>
</tr>
<tr>
<td>array</td>
<td>$params</td>
<td><p>additional parameters to be passed with the form</p></td>
</tr>
<tr>
<td>bool</td>
<td>$inline</td>
<td><p>wether this is an inline form request (output will replace module tag rather than the entire content section of the template.</p></td>
</tr>
<tr>
<td>string</td>
<td>$method</td>
<td><p>The form method.</p></td>
</tr>
<tr>
<td>string</td>
<td>$enctype</td>
<td><p>The form encoding type</p></td>
</tr>
<tr>
<td>string</td>
<td>$idsuffix</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$extra</td>
<td><p>Extra text for thhe form tag</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CGCreateFrontendFormStart" name="method_CGCreateFrontendFormStart" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">CGCreateFrontendFormStart()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CGCreateFrontendFormStart(string <span class="argument">$id</span>, string <span class="argument">$action</span>, string <span class="argument">$returnid</span>, array <span class="argument">$params</span>, bool <span class="argument">$inline</span>, string <span class="argument">$method</span>, string <span class="argument">$enctype</span>, string <span class="argument">$idsuffix</span>, string <span class="argument">$extra</span>) : string</pre>
<p><em>A convenience function for creating a frontend form
This method re-organises some of the parameters of the original CreateFormStart method
and sets the encoding type of the form to multipart/form-data</em></p>
<p>This method is deprecated and will be replaced in CMSMS 2.0 by the core {form_start} tag.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>the module action id</p></td>
</tr>
<tr>
<td>string</td>
<td>$action</td>
<td><p>the destination action</p></td>
</tr>
<tr>
<td>string</td>
<td>$returnid</td>
<td><p>The destination pagpe for the action handler. Empty for admin requests</p></td>
</tr>
<tr>
<td>array</td>
<td>$params</td>
<td><p>additional parameters to be passed with the form</p></td>
</tr>
<tr>
<td>bool</td>
<td>$inline</td>
<td><p>wether this is an inline form request (output will replace module tag rather than the entire content section of the template.</p></td>
</tr>
<tr>
<td>string</td>
<td>$method</td>
<td><p>The form method.</p></td>
</tr>
<tr>
<td>string</td>
<td>$enctype</td>
<td><p>The form encoding type</p></td>
</tr>
<tr>
<td>string</td>
<td>$idsuffix</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$extra</td>
<td><p>Extra text for thhe form tag</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CreateInputHidden" name="method_CreateInputHidden" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">CreateInputHidden()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CreateInputHidden(string <span class="argument">$id</span>, string <span class="argument">$name</span>, string <span class="argument">$value</span>, string <span class="argument">$addtext</span>, string <span class="argument">$delim</span>) : string</pre>
<p><em>A convenience method to create a hidden input element for forms.</em></p>
<p>This method is deprecated. It is best to assign all data to smarty and then create input elements as necessary in the smarty template.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>the module action id</p></td>
</tr>
<tr>
<td>string</td>
<td>$name</td>
<td><p>The name of the input element</p></td>
</tr>
<tr>
<td>string</td>
<td>$value</td>
<td><p>The value of the input element</p></td>
</tr>
<tr>
<td>string</td>
<td>$addtext</td>
<td><p>Additional text for the tag</p></td>
</tr>
<tr>
<td>string</td>
<td>$delim</td>
<td><p>the delimiter for value separation.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_RedirectToTab" name="method_RedirectToTab" class="anchor"></a>
<article class="method">
<h3 class="public ">RedirectToTab()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">RedirectToTab(string <span class="argument">$id</span>, string <span class="argument">$tab</span>, string <span class="argument">$params</span>, string <span class="argument">$action</span>)</pre>
<p><em>For admin requests only, pass variables so that the specified tab will be displayed
by default in the resulting action.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>the module action id. For admin requests this is usually 'm1_'</p></td>
</tr>
<tr>
<td>string</td>
<td>$tab</td>
<td><p>The name of the parameter</p></td>
</tr>
<tr>
<td>string</td>
<td>$params</td>
<td><p>Extra parameters for the request</p></td>
</tr>
<tr>
<td>string</td>
<td>$action</td>
<td><p>The designated module action. If none is specified 'defaultadmin' is assumed.</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_Redirect" name="method_Redirect" class="anchor"></a>
<article class="method">
<h3 class="public ">Redirect()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">Redirect(string <span class="argument">$id</span>, string <span class="argument">$action</span>, int <span class="argument">$returnid</span>, array <span class="argument">$params</span>, bool <span class="argument">$inline</span>)</pre>
<p><em>Redirect to a specified module action.</em></p>
<p>This method is usable both for admin and frontend requests.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>the module action id. For admin requests this is usually 'm1_'</p></td>
</tr>
<tr>
<td>string</td>
<td>$action</td>
<td><p>The designated module action. If none is specified 'defaultadmin' is assumed.</p></td>
</tr>
<tr>
<td>int</td>
<td>$returnid</td>
<td><p>The destination page. empty for admin requests.</p></td>
</tr>
<tr>
<td>array</td>
<td>$params</td>
<td><p>Extra parameters for the URL</p></td>
</tr>
<tr>
<td>bool</td>
<td>$inline</td>
<td><p>Wether the output should be an inline URL or not ??</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_IsAdminAction" name="method_IsAdminAction" class="anchor"></a>
<article class="method">
<h3 class="public ">IsAdminAction()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">IsAdminAction() : bool</pre>
<p><em>Test if the current code is handling an admin action or a frontend action</em></p>
<h4>Returns</h4>
bool
— <p>True for an admin action, false otherwise.</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_SetError" name="method_SetError" class="anchor"></a>
<article class="method">
<h3 class="public ">SetError()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">SetError(string <span class="argument">$str</span>)</pre>
<p><em>Set an error to display on the next admin request from a CGExtensions derived module.</em></p>
<p>The error message will be carried on to the next admin request and displayed.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$str</td>
<td><p>The error message.</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_SetMessage" name="method_SetMessage" class="anchor"></a>
<article class="method">
<h3 class="public ">SetMessage()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">SetMessage(string <span class="argument">$str</span>)</pre>
<p><em>Set a message to display on the next admin request from a CGExtensions derived module.</em></p>
<p>The message will be carried on to the next admin request and displayed.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$str</td>
<td><p>The informational message to display.</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_DisplayErrors" name="method_DisplayErrors" class="anchor"></a>
<article class="method">
<h3 class="public ">DisplayErrors()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">DisplayErrors()</pre>
<p><em>Display any set error message in the admin console.</em></p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_DisplayMessages" name="method_DisplayMessages" class="anchor"></a>
<article class="method">
<h3 class="public ">DisplayMessages()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">DisplayMessages()</pre>
<p><em>Display any set informational messages in the admin console.</em></p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_SetCurrentAction" name="method_SetCurrentAction" class="anchor"></a>
<article class="method">
<h3 class="public ">SetCurrentAction()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">SetCurrentAction(string <span class="argument">$action</span>)</pre>
<p><em>Set the current action for the next request of the admin console.</em></p>
<p>Used for the various admin forms.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$action</td>
<td><p>The action name</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_SetCurrentTab" name="method_SetCurrentTab" class="anchor"></a>
<article class="method">
<h3 class="public ">SetCurrentTab()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">SetCurrentTab(string <span class="argument">$tab</span>)</pre>
<p><em>Set the current tab for the next request of the admin console.</em></p>
<p>Used for the various template forms.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$tab</td>
<td><p>The tab name.</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_SetTabHeader" name="method_SetTabHeader" class="anchor"></a>
<article class="method">
<h3 class="public ">SetTabHeader()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">SetTabHeader(string <span class="argument">$name</span>, string <span class="argument">$str</span>, mixed <span class="argument">$state</span>)</pre>
<p><em>A replacement for the built in SetTabHeader.</em></p>
<p>This method is a smart replacement that will automatically handle an active tab on the
requiest.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$name</td>
<td><p>The tab name (for coding purposes)</p></td>
</tr>
<tr>
<td>string</td>
<td>$str</td>
<td><p>The human readable label for the tab.</p></td>
</tr>
<tr>
<td>mixed</td>
<td>$state</td>
<td><p>If Empty or 'unknown' then detect any currently set tab.</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_DisplayErrorMessage" name="method_DisplayErrorMessage" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">DisplayErrorMessage()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">DisplayErrorMessage(string <span class="argument">$txt</span>, string <span class="argument">$class</span>)</pre>
<p><em>A function for using a template to display an error message.</em></p>
<p>This method is suitable for frontend displays.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$txt</td>
<td><p>The error message</p></td>
</tr>
<tr>
<td>string</td>
<td>$class</td>
<td><p>An optional class attribute value.</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetErrorTemplate" name="method_GetErrorTemplate" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">GetErrorTemplate()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetErrorTemplate()</pre>
<p><em>A convenience function for retrieving the current error template</em></p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_ResetErrorTemplate" name="method_ResetErrorTemplate" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">ResetErrorTemplate()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">ResetErrorTemplate()</pre>
<p><em>Reset the error template to factory defaults</em></p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_SetErrorTemplate" name="method_SetErrorTemplate" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">SetErrorTemplate()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">SetErrorTemplate(string <span class="argument">$tmpl</span>)</pre>
<p><em>Set the error template</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$tmpl</td>
<td><p>Smarty Template source</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CreateInputStateDropdown" name="method_CreateInputStateDropdown" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">CreateInputStateDropdown()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CreateInputStateDropdown(string <span class="argument">$id</span>, string <span class="argument">$name</span>, string <span class="argument">$value</span>, mixed <span class="argument">$selectone</span>, string <span class="argument">$addtext</span>)</pre>
<p><em>A convenience function to create a state dropdown list.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>The module action id</p></td>
</tr>
<tr>
<td>string</td>
<td>$name</td>
<td><p>the name for the dropdown.</p></td>
</tr>
<tr>
<td>string</td>
<td>$value</td>
<td><p>The initial value for the dropdown.</p></td>
</tr>
<tr>
<td>mixed</td>
<td>$selectone</td>
<td><p>If true, then a hardcoded "Select One" string will be prepended to the list. If a string then that string will be used.</p></td>
</tr>
<tr>
<td>string</td>
<td>$addtext</td>
<td><p>Additional text for the select tag.</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CreateInputCountryDropdown" name="method_CreateInputCountryDropdown" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">CreateInputCountryDropdown()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CreateInputCountryDropdown(string <span class="argument">$id</span>, string <span class="argument">$name</span>, string <span class="argument">$value</span>, mixed <span class="argument">$selectone</span>, string <span class="argument">$addtext</span>)</pre>
<p><em>A convenience function to create a country dropdown list</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>The module action id</p></td>
</tr>
<tr>
<td>string</td>
<td>$name</td>
<td><p>the name for the dropdown.</p></td>
</tr>
<tr>
<td>string</td>
<td>$value</td>
<td><p>The initial value for the dropdown.</p></td>
</tr>
<tr>
<td>mixed</td>
<td>$selectone</td>
<td><p>If true, then a hardcoded "Select One" string will be prepended to the list. If a string then that string will be used.</p></td>
</tr>
<tr>
<td>string</td>
<td>$addtext</td>
<td><p>Additional text for the select tag.</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetCountry" name="method_GetCountry" class="anchor"></a>
<article class="method">
<h3 class="public ">GetCountry()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetCountry(string <span class="argument">$the_acronym</span>) : string</pre>
<p><em>A convenience function to get the country name given the acronym</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$the_acronym</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetState" name="method_GetState" class="anchor"></a>
<article class="method">
<h3 class="public ">GetState()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetState(string <span class="argument">$the_acronym</span>) : string</pre>
<p><em>A convenience function to get the state name given the acronym</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$the_acronym</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CreateImageDropdown" name="method_CreateImageDropdown" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">CreateImageDropdown()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CreateImageDropdown(string <span class="argument">$id</span>, string <span class="argument">$name</span>, string <span class="argument">$selectedfile</span>, string <span class="argument">$dir</span>, mixed <span class="argument">$none</span>) : \string.</pre>
<p><em>A convenience function to create an image dropdown from all of the image files in a specified directory.</em></p>
<p>This method will not ignore thumbnails.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>The module action id</p></td>
</tr>
<tr>
<td>string</td>
<td>$name</td>
<td><p>the name for the dropdown.</p></td>
</tr>
<tr>
<td>string</td>
<td>$selectedfile</td>
<td><p>The initial value for the dropdown (an image filename)</p></td>
</tr>
<tr>
<td>string</td>
<td>$dir</td>
<td><p>The path (relative to the uploads path) to the directory to pull images from. If not specified, the image uploads path will be used.</p></td>
</tr>
<tr>
<td>mixed</td>
<td>$none</td>
<td><p>If true, then 'None' will be prepended to the list of output images. If a string it's value will be used.</p></td>
</tr>
</table>
<h4>Returns</h4>
\string.
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CreateFileDropdown" name="method_CreateFileDropdown" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">CreateFileDropdown()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CreateFileDropdown(string <span class="argument">$id</span>, string <span class="argument">$name</span>, string <span class="argument">$selectedfile</span>, string <span class="argument">$dir</span>, string <span class="argument">$extensions</span>, bool <span class="argument">$allownone</span>, bool <span class="argument">$allowmultiple</span>, int <span class="argument">$size</span>) : \string.</pre>
<p><em>A convenience function to create a list of filenames in a specified directory.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>The module action id</p></td>
</tr>
<tr>
<td>string</td>
<td>$name</td>
<td><p>the name for the dropdown.</p></td>
</tr>
<tr>
<td>string</td>
<td>$selectedfile</td>
<td><p>The initial value for the dropdown (an image filename)</p></td>
</tr>
<tr>
<td>string</td>
<td>$dir</td>
<td><p>The path (relative to the uploads path) to the directory to pull images from. If not specified, the image uploads path will be used.</p></td>
</tr>
<tr>
<td>string</td>
<td>$extensions</td>
<td><p>A comma separated list of filename extensions to include in the list. If not specified the module preference will be used.</p></td>
</tr>
<tr>
<td>bool</td>
<td>$allownone</td>
<td><p>Allow no files to be selected.</p></td>
</tr>
<tr>
<td>bool</td>
<td>$allowmultiple</td>
<td><p>To allow selecting multiple files.</p></td>
</tr>
<tr>
<td>int</td>
<td>$size</td>
<td><p>The size of the dropdown.</p></td>
</tr>
</table>
<h4>Returns</h4>
\string.
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CreateColorDropdown" name="method_CreateColorDropdown" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">CreateColorDropdown()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CreateColorDropdown(string <span class="argument">$id</span>, string <span class="argument">$name</span>, string <span class="argument">$selectedvalue</span>) : string</pre>
<p><em>A convenience function to create a color selection dropdown</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>The module action id</p></td>
</tr>
<tr>
<td>string</td>
<td>$name</td>
<td><p>the name for the dropdown.</p></td>
</tr>
<tr>
<td>string</td>
<td>$selectedvalue</td>
<td><p>The initial value for the input field.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CreateImageTag" name="method_CreateImageTag" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">CreateImageTag()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CreateImageTag(string <span class="argument">$id</span>, string <span class="argument">$alt</span>, int <span class="argument">$width</span>, int <span class="argument">$height</span>, string <span class="argument">$class</span>, string <span class="argument">$addtext</span>) : string</pre>
<p><em>A convenience method to create an image tag.</em></p>
<p>This method will automatically search through added image dirs for frontend and admin requests
and through the admin theme directories for admin requests.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>The module action id</p></td>
</tr>
<tr>
<td>string</td>
<td>$alt</td>
<td><p>The alt attribute for the tag</p></td>
</tr>
<tr>
<td>int</td>
<td>$width</td>
<td><p>Width in pixels</p></td>
</tr>
<tr>
<td>int</td>
<td>$height</td>
<td><p>Height in pixels</p></td>
</tr>
<tr>
<td>string</td>
<td>$class</td>
<td><p>Value for the class attribute</p></td>
</tr>
<tr>
<td>string</td>
<td>$addtext</td>
<td><p>Additional text for the img tag.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_DisplayImage" name="method_DisplayImage" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">DisplayImage()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">DisplayImage(string <span class="argument">$image</span>, string <span class="argument">$alt</span>, string <span class="argument">$class</span>, int <span class="argument">$width</span>, int <span class="argument">$height</span>) : string</pre>
<p><em>A convenience method to display an image.</em></p>
<p>This method will automatically search through added image dirs for frontend and admin requests
and through the admin theme directories for admin requests.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$image</td>
<td><p>The basename for the desired image.</p></td>
</tr>
<tr>
<td>string</td>
<td>$alt</td>
<td><p>The alt attribute for the tag</p></td>
</tr>
<tr>
<td>string</td>
<td>$class</td>
<td><p>Value for the class attribute</p></td>
</tr>
<tr>
<td>int</td>
<td>$width</td>
<td><p>Width in pixels</p></td>
</tr>
<tr>
<td>int</td>
<td>$height</td>
<td><p>Height in pixels</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CreateImageLink" name="method_CreateImageLink" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">CreateImageLink()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CreateImageLink(string <span class="argument">$id</span>, string <span class="argument">$action</span>, int <span class="argument">$returnid</span>, string <span class="argument">$contents</span>, string <span class="argument">$image</span>, array <span class="argument">$params</span>, string <span class="argument">$classname</span>, string <span class="argument">$warn_message</span>, bool <span class="argument">$imageonly</span>, bool <span class="argument">$inline</span>, string <span class="argument">$addtext</span>, bool <span class="argument">$targetcontentonly</span>, string <span class="argument">$prettyurl</span>) : string</pre>
<p><em>A convenience method to create a link to a module action containing an image and optionally some text.</em></p>
<p>This method will automatically search through added image dirs for frontend and admin requests
and through the admin theme directories for admin requests.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>The module action id</p></td>
</tr>
<tr>
<td>string</td>
<td>$action</td>
<td><p>The name of the destination action</p></td>
</tr>
<tr>
<td>int</td>
<td>$returnid</td>
<td><p>The page for the destination of the request. Empty for admin requests.</p></td>
</tr>
<tr>
<td>string</td>
<td>$contents</td>
<td><p>The text content of the image.</p></td>
</tr>
<tr>
<td>string</td>
<td>$image</td>
<td><p>The basename of the image to display.</p></td>
</tr>
<tr>
<td>array</td>
<td>$params</td>
<td><p>Additional link parameters</p></td>
</tr>
<tr>
<td>string</td>
<td>$classname</td>
<td><p>Class for the img tag.</p></td>
</tr>
<tr>
<td>string</td>
<td>$warn_message</td>
<td><p>An optional confirmation message</p></td>
</tr>
<tr>
<td>bool</td>
<td>$imageonly</td>
<td><p>Wether the contents (if specified) should be ignored.</p></td>
</tr>
<tr>
<td>bool</td>
<td>$inline</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$addtext</td>
<td></td>
</tr>
<tr>
<td>bool</td>
<td>$targetcontentonly</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$prettyurl</td>
<td><p>An optional pretty url slug.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_AddImageDir" name="method_AddImageDir" class="anchor"></a>
<article class="method">
<h3 class="public ">AddImageDir()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">AddImageDir(string <span class="argument">$dir</span>)</pre>
<p><em>Add a directory to the list of searchable directories</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$dir</td>
<td><p>A directory relative to this modules installation directory.</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_ListTemplatesWithPrefix" name="method_ListTemplatesWithPrefix" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">ListTemplatesWithPrefix()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">ListTemplatesWithPrefix(string <span class="argument">$prefix</span>, bool <span class="argument">$trim</span>) : array</pre>
<p><em>List all templates stored with this module that begin with the same prefix.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$prefix</td>
<td><p>The optional prefix</p></td>
</tr>
<tr>
<td>bool</td>
<td>$trim</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
<dt>See also</dt>
<dd><a href="../classes/cge_template_utils.html#method_get_templates_by_prefix"><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CreateTemplateDropdown" name="method_CreateTemplateDropdown" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">CreateTemplateDropdown()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CreateTemplateDropdown(string <span class="argument">$id</span>, string <span class="argument">$name</span>, string <span class="argument">$prefix</span>, string <span class="argument">$selectedvalue</span>, string <span class="argument">$addtext</span>) : string</pre>
<p><em>Create a dropdown of all templates beginning with the specified prefix</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>The module action id</p></td>
</tr>
<tr>
<td>string</td>
<td>$name</td>
<td><p>The name for the input element.</p></td>
</tr>
<tr>
<td>string</td>
<td>$prefix</td>
<td><p>The optional prefix</p></td>
</tr>
<tr>
<td>string</td>
<td>$selectedvalue</td>
<td><p>The default value for the input element</p></td>
</tr>
<tr>
<td>string</td>
<td>$addtext</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_ShowTemplateList" name="method_ShowTemplateList" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">ShowTemplateList()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">ShowTemplateList(string <span class="argument">$id</span>, int <span class="argument">$returnid</span>, string <span class="argument">$prefix</span>, string <span class="argument">$defaulttemplatepref</span>, string <span class="argument">$active_tab</span>, string <span class="argument">$defaultprefname</span>, string <span class="argument">$title</span>, string <span class="argument">$info</span>, string <span class="argument">$destaction</span>)</pre>
<p><em>Part of the multiple database template functionality
this function provides an interface for adding, editing,
deleting and marking active all templates that match
a prefix.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$id</td>
<td><p>The module action id (pass in the value from doaction)</p></td>
</tr>
<tr>
<td>int</td>
<td>$returnid</td>
<td><p>The page id to use on subsequent forms and links.</p></td>
</tr>
<tr>
<td>string</td>
<td>$prefix</td>
<td><p>The template prefix</p></td>
</tr>
<tr>
<td>string</td>
<td>$defaulttemplatepref</td>
<td><p>The name of the template containing the system default template. This can either be the name of a database template or a filename ending with .tpl.</p></td>
</tr>
<tr>
<td>string</td>
<td>$active_tab</td>
<td><p>The tab to return to</p></td>
</tr>
<tr>
<td>string</td>
<td>$defaultprefname</td>
<td><p>The name of the preference that contains the name of the current default template. If empty string then there will be no possibility to set a default template for this list.</p></td>
</tr>
<tr>
<td>string</td>
<td>$title</td>
<td><p>Title text to display in the add/edit template form</p></td>
</tr>
<tr>
<td>string</td>
<td>$info</td>
<td><p>Information text to display in the add/edit template form</p></td>
</tr>
<tr>
<td>string</td>
<td>$destaction</td>
<td><p>The action to return to.</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
Use the CmsLayoutTemplate class(es) in 2.0 capable modules.
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetDefaultTemplateForm" name="method_GetDefaultTemplateForm" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">GetDefaultTemplateForm()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetDefaultTemplateForm(\GExtensions <span class="argument">$module</span>, string <span class="argument">$id</span>, string <span class="argument">$returnid</span>, string <span class="argument">$prefname</span>, string <span class="argument">$action</span>, string <span class="argument">$active_tab</span>, string <span class="argument">$title</span>, string <span class="argument">$filename</span>, string <span class="argument">$info</span>) : string</pre>
<p><em>GetDefaultTemplateForm.</em></p>
<p>A function to return a form suitable for editing a single template.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>\GExtensions</td>
<td>$module</td>
<td><p>A CGExtensions derived module reference</p></td>
</tr>
<tr>
<td>string</td>
<td>$id</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$returnid</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$prefname</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$action</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$active_tab</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$title</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$filename</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$info</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
(this functionality is irrelevant in CMSMS 2.0)
</aside>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_EditDefaultTemplateForm" name="method_EditDefaultTemplateForm" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">EditDefaultTemplateForm()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">EditDefaultTemplateForm(\GExtensions <span class="argument">$module</span>, string <span class="argument">$id</span>, string <span class="argument">$returnid</span>, string <span class="argument">$prefname</span>, string <span class="argument">$active_tab</span>, string <span class="argument">$title</span>, string <span class="argument">$filename</span>, string <span class="argument">$info</span>, string <span class="argument">$action</span>) : string</pre>
<p><em>EditDefaultTemplateForm</em></p>
<p>A function to return a form suitable for editing a single template.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>\GExtensions</td>
<td>$module</td>
<td><p>A CGExtensions derived module reference</p></td>
</tr>
<tr>
<td>string</td>
<td>$id</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$returnid</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$prefname</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$active_tab</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$title</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$filename</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$info</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$action</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
(this functionality is irrelevant in CMSMS 2.0)
</aside>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CreateContentURL" name="method_CreateContentURL" class="anchor"></a>
<article class="method">
<h3 class="public ">CreateContentURL()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CreateContentURL(mixed <span class="argument">$pageid</span>) : string</pre>
<p><em>A convenience function to create a url to a certain CMS page</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>mixed</td>
<td>$pageid</td>
<td><p>A frontend page id or alias.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetAdminUsername" name="method_GetAdminUsername" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">GetAdminUsername()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetAdminUsername(int <span class="argument">$uid</span>) : string</pre>
<p><em>Get the username of the currently logged in admin user.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>int</td>
<td>$uid</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetUploadErrorMessage" name="method_GetUploadErrorMessage" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">GetUploadErrorMessage()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetUploadErrorMessage(string <span class="argument">$code</span>) : string</pre>
<p><em>Get a human readable error message for an upload code.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$code</td>
<td><p>The upload error code.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
<dt>See also</dt>
<dd><a href="../classes/cg_fileupload.html"><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetSingleTemplateForm" name="method_GetSingleTemplateForm" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">GetSingleTemplateForm()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetSingleTemplateForm(\CGExtensions <span class="argument">$module</span>, string <span class="argument">$id</span>, int <span class="argument">$returnid</span>, string <span class="argument">$tmplname</span>, string <span class="argument">$active_tab</span>, string <span class="argument">$title</span>, string <span class="argument">$filename</span>, string <span class="argument">$info</span>, string <span class="argument">$destaction</span>)</pre>
<p><em>Get a form for adding or editing a single template.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td><a href="../classes/CGExtensions.html">\CGExtensions</a></td>
<td>$module</td>
<td><p>A CGExtensions module reference</p></td>
</tr>
<tr>
<td>string</td>
<td>$id</td>
<td></td>
</tr>
<tr>
<td>int</td>
<td>$returnid</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$tmplname</td>
<td><p>The name of the template to edit</p></td>
</tr>
<tr>
<td>string</td>
<td>$active_tab</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$title</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$filename</td>
<td><p>The name of the file (in the module's template directory) containing the system default template.</p></td>
</tr>
<tr>
<td>string</td>
<td>$info</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$destaction</td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetWatermarkError" name="method_GetWatermarkError" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">GetWatermarkError()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetWatermarkError(string <span class="argument">$error</span>) : string</pre>
<p><em>Retrieve a human readable string for any error generated during watermarking.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$error</td>
<td><p>the watermarking error code</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_InitializeCharting" name="method_InitializeCharting" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">InitializeCharting()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">InitializeCharting()</pre>
<p><em>Setup and initializing charting functionality</em></p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_InitializeAssocData" name="method_InitializeAssocData" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">InitializeAssocData()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">InitializeAssocData()</pre>
<p><em>Initialize associative data functionality</em></p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_session_clear" name="method_session_clear" class="anchor"></a>
<article class="method">
<h3 class="public ">session_clear()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">session_clear(string <span class="argument">$key</span>)</pre>
<p><em>A convenience method to clear any session data associated with this module.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$key</td>
<td><p>If not specified clear all session data relative to this module."</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_session_put" name="method_session_put" class="anchor"></a>
<article class="method">
<h3 class="public ">session_put()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">session_put(string <span class="argument">$key</span>, string <span class="argument">$value</span>)</pre>
<p><em>A convenience method to store some session data associated with this module.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$key</td>
<td><p>The variable key.</p></td>
</tr>
<tr>
<td>string</td>
<td>$value</td>
<td><p>The data to store.</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_session_get" name="method_session_get" class="anchor"></a>
<article class="method">
<h3 class="public ">session_get()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">session_get(string <span class="argument">$key</span>, string <span class="argument">$dfltvalue</span>) : \mixed.</pre>
<p><em>A convenience method to retrieve some session data associated with this module.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$key</td>
<td><p>The variable key.</p></td>
</tr>
<tr>
<td>string</td>
<td>$dfltvalue</td>
<td><p>"The default value to return if the specified data does not exist."</p></td>
</tr>
</table>
<h4>Returns</h4>
\mixed.
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_param_session_get" name="method_param_session_get" class="anchor"></a>
<article class="method">
<h3 class="public ">param_session_get()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">param_session_get(array <span class="argument">$params</span>, string <span class="argument">$key</span>, string <span class="argument">$defaultvalue</span>) : \mixed.</pre>
<p><em>Return data identified by a key either from the supplied parameters, or from session.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$params</td>
<td><p>Input parameters</p></td>
</tr>
<tr>
<td>string</td>
<td>$key</td>
<td><p>The data key</p></td>
</tr>
<tr>
<td>string</td>
<td>$defaultvalue</td>
<td><p>The data to return if the specified data does not exist in the session or in the input parameters.</p></td>
</tr>
</table>
<h4>Returns</h4>
\mixed.
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_resolve_alias_or_id" name="method_resolve_alias_or_id" class="anchor"></a>
<article class="method">
<h3 class="public ">resolve_alias_or_id()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">resolve_alias_or_id(mixed <span class="argument">$txt</span>, int <span class="argument">$dflt</span>) : int</pre>
<p><em>Given a page alias resolve it to a page id.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>mixed</td>
<td>$txt</td>
<td><p>The page alias to resolve. If an integer page id is passed in that is acceptable as well.</p></td>
</tr>
<tr>
<td>int</td>
<td>$dflt</td>
<td><p>The default page id to return if no match can be found</p></td>
</tr>
</table>
<h4>Returns</h4>
int
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_http_post" name="method_http_post" class="anchor"></a>
<article class="method">
<h3 class="public ">http_post()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">http_post(string <span class="argument">$URL</span>, array <span class="argument">$data</span>, string <span class="argument">$referer</span>) : string</pre>
<p><em>Perform an HTTP post request.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$URL</td>
<td><p>the url to post to</p></td>
</tr>
<tr>
<td>array</td>
<td>$data</td>
<td><p>The array to post.</p></td>
</tr>
<tr>
<td>string</td>
<td>$referer</td>
<td><p>An optional referrer string.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_http_get" name="method_http_get" class="anchor"></a>
<article class="method">
<h3 class="public ">http_get()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">http_get(string <span class="argument">$URL</span>, string <span class="argument">$referer</span>) : string</pre>
<p><em>Perform an HTTP GET request.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$URL</td>
<td><p>the url to post to</p></td>
</tr>
<tr>
<td>string</td>
<td>$referer</td>
<td><p>An optional referrer string.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CGGetPreference" name="method_CGGetPreference" class="anchor"></a>
<article class="method">
<h3 class="public ">CGGetPreference()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CGGetPreference(string <span class="argument">$pref_name</span>, string <span class="argument">$dflt_value</span>, bool <span class="argument">$allow_empty</span>) : \string.</pre>
<p><em>Similar to GetPreference except the default value is used even if the preference exists, but is blank.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$pref_name</td>
<td><p>The preference name</p></td>
</tr>
<tr>
<td>string</td>
<td>$dflt_value</td>
<td><p>The default value for the preference if not set (or empty)</p></td>
</tr>
<tr>
<td>bool</td>
<td>$allow_empty</td>
<td><p>Wether the default value should be used if the preference exists, but is empty.</p></td>
</tr>
</table>
<h4>Returns</h4>
\string.
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CGGetUserPreference" name="method_CGGetUserPreference" class="anchor"></a>
<article class="method">
<h3 class="public ">CGGetUserPreference()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CGGetUserPreference(string <span class="argument">$pref_name</span>, string <span class="argument">$dflt_value</span>, bool <span class="argument">$allow_empty</span>) : \string.</pre>
<p><em>A wrapper to get a module specific user preference.</em></p>
<p>this method only applies to admin users.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$pref_name</td>
<td><p>The preference name</p></td>
</tr>
<tr>
<td>string</td>
<td>$dflt_value</td>
<td><p>The default value for the preference if not set (or empty)</p></td>
</tr>
<tr>
<td>bool</td>
<td>$allow_empty</td>
<td><p>Wether the default value should be used if the preference exists, but is empty.</p></td>
</tr>
</table>
<h4>Returns</h4>
\string.
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CGSetUserPreference" name="method_CGSetUserPreference" class="anchor"></a>
<article class="method">
<h3 class="public ">CGSetUserPreference()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CGSetUserPreference(string <span class="argument">$pref_name</span>, string <span class="argument">$value</span>)</pre>
<p><em>A wrapper to set a user preference that is module specific.</em></p>
<p>this method only applies to admin users.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$pref_name</td>
<td><p>The preference name</p></td>
</tr>
<tr>
<td>string</td>
<td>$value</td>
<td><p>The preference value.</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CGRemoveUserPreference" name="method_CGRemoveUserPreference" class="anchor"></a>
<article class="method">
<h3 class="public ">CGRemoveUserPreference()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CGRemoveUserPreference(string <span class="argument">$pref_name</span>)</pre>
<p><em>A wrapper to remove a user preference that is module specific.</em></p>
<p>this method only applies to admin users.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$pref_name</td>
<td><p>The preference name</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_find_file" name="method_find_file" class="anchor"></a>
<article class="method">
<h3 class="public ">find_file()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">find_file(string <span class="argument">$filename</span>) : string</pre>
<p><em>find a file for this module
looks in module_custom, and in the module directory</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$filename</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CGGetTemplateResource" name="method_CGGetTemplateResource" class="anchor"></a>
<article class="method">
<h3 class="public ">CGGetTemplateResource()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CGGetTemplateResource(string <span class="argument">$template_name</span>, string <span class="argument">$prefix</span>) : string</pre>
<p><em>A convenience method to generate a smarty resource string given a template name and an optional prefix.</em></p>
<p>if the supplied template name ends with .tpl then a file template is assumed.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$template_name</td>
<td><p>The desired template name</p></td>
</tr>
<tr>
<td>string</td>
<td>$prefix</td>
<td><p>an optional prefix for database templates.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_CGProcessTemplate" name="method_CGProcessTemplate" class="anchor"></a>
<article class="method">
<h3 class="public ">CGProcessTemplate()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">CGProcessTemplate(string <span class="argument">$template_name</span>, string <span class="argument">$prefix</span>) : string</pre>
<p><em>An advanced method to process either a file, or database template for this module
through smarty</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$template_name</td>
<td><p>The template name. If the value of this parameter ends with .tpl then a file template is assumed. Otherwise a database template is assumed.</p></td>
</tr>
<tr>
<td>string</td>
<td>$prefix</td>
<td><p>For database templates, optionally prefix thie template name with this value.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
— <p>The output from the processed smarty template.</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_GetActionModule" name="method_GetActionModule" class="anchor"></a>
<article class="method">
<h3 class="public ">GetActionModule()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">GetActionModule() : string</pre>
<p><em>Get the name of the module that the current action is for.</em></p>
<p>(only works with modules derived from CGExtensions).
This method is useful to find the module action that was used to send an event.</p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_get_state_list" name="method_get_state_list" class="anchor"></a>
<article class="method">
<h3 class="protected ">get_state_list()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">get_state_list() : array</pre>
<p><em>A function to return an array of of country codes and country names.</em></p>
<p>i.e: array( array('code'=>'AB','name'=>'Alberta'), array('code'=>'MB','code'=>'Manitoba'));</p>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_get_state_list_options" name="method_get_state_list_options" class="anchor"></a>
<article class="method">
<h3 class="protected ">get_state_list_options()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">get_state_list_options() : array</pre>
<p><em>A function to return an array of of country codes and country names.</em></p>
<p>This method returns data that is suitable for use in a list.
i.e: array( array('code'=>'AB','name'=>'Alberta'), array('code'=>'MB','code'=>'Manitoba'));</p>
<h4>Returns</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_get_country_list" name="method_get_country_list" class="anchor"></a>
<article class="method">
<h3 class="protected ">get_country_list()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">get_country_list()</pre>
<p><em>A function to return an array of of country codes and country names.</em></p>
<p>i.e: array( array('code'=>'US','name'=>'United States'), array('code'=>'CA','code'=>'Canada'));</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_get_country_list_options" name="method_get_country_list_options" class="anchor"></a>
<article class="method">
<h3 class="protected ">get_country_list_options()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">get_country_list_options()</pre>
<p><em>A function to return an array of of country codes and country names.</em></p>
<p>This method returns data suitable for giving to smarty and displaying in a dropdown.</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
</div>
</section>
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
<h3 id="source-view-label">CGExtensions.module.php</h3>
</div>
<div class="modal-body">
<pre data-src="../files/CGExtensions.module.php.txt" class="language-php line-numbers"></pre>
</div>
</div>
<footer class="row-fluid">
<section class="span10 offset2">
<section class="row-fluid">
<section class="span10 offset1">
<section class="row-fluid footer-sections">
<section class="span4">
<h1><i class="icon-code"></i></h1>
<div>
<ul>
<li><a href="../namespaces/CGExtensions.html">\CGExtensions</a></li>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-bar-chart"></i></h1>
<div>
<ul>
<li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-pushpin"></i></h1>
<div>
<ul>
<li><a href="../reports/errors.html">Errors</a></li>
<li><a href="../reports/markers.html">Markers</a></li>
</ul>
</div>
</section>
</section>
</section>
</section>
<section class="row-fluid">
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on January 17th, 2015 at 10:19.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>