xml Miva - 一个模块中所有功能的示例
Posted
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了xml Miva - 一个模块中所有功能的示例相关的知识，希望对你有一定的参考价值。
<MIVA STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL=""><MvEVAL EXPR="{ CommandLine() }"><MvEXIT>
<MvCOMMENT>
http://pdqcoders.com/mm5/merchant.mvc?Screen=MB
</MvCOMMENT>
<MvFUNCTION NAME = "Module_Description" PARAMETERS = "module var" STANDARDOUTPUTLEVEL = "">
<MvASSIGN NAME = "l.module:code" VALUE = "foobar">
<MvASSIGN NAME = "l.module:name" VALUE = "FooBar">
<MvASSIGN NAME = "l.module:provider" VALUE = "ssoule">
<MvASSIGN NAME = "l.module:version" VALUE = "0.0.0">
<MvASSIGN NAME = "l.module:api_ver" VALUE = "5.73">
<MvASSIGN NAME = "l.module:features" VALUE = "util,vis_util,system,vis_system,data_domain,vis_domain,data_store,vis_store,log,vis_log,payment,vis_payment,shipping,vis_shipping,fulfill,vis_fulfill,import,export,batchreport,currency,component,discount,tax,json,provision_store,boxpacking,wizard,vis_pkgrules,vis_wizard,component_prov,custrt,vis_affil,vis_affilbe,vis_category,vis_categorybe,vis_product,vis_productbe,vis_cust,vis_custbe,vis_order,cleanup_store,clientside,designer,report,storewizard,skins,shipping_label,externalreq,fields_cat,fields_cat_map,fields_cust,fields_prod,fields_prod_map,not_cat,not_cust,not_fields,not_giftcert,not_image,not_order,not_orderitem,not_orderreturn,not_ordershpmnt,not_prod,not_seo,storeui,storeselui">
<MvASSIGN NAME = "l.module:description" VALUE = "Testing all Module Builder settings">
</MvFUNCTION>
<MvFUNCTION NAME = "CommandLine" PARAMETERS = "" STANDARDOUTPUTLEVEL = "">
<MvCOMMENT> Process the command line </MvCOMMENT>
</MvFUNCTION>
<MvCOMMENT> util </MvCOMMENT>
<MvFUNCTION NAME="StoreUtilityModule_Action" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
The Miva Merchant Admin calls this function if StoreUtilityModule_Validate returns a success.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="StoreUtilityModule_LeftNavigation" PARAMETERS="module var, indent" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
The Miva Merchant Admin calls this function to determine what to place in its left menu. The
indent parameter tells Admin at what depth of indentation to display the link. For example, an
indent value of ‘2’ would represent the second indent level. The variable Screen=SUTL can be
placed in the link, which will cause Admin to call StoreUtilityModule_Screen.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="StoreUtilityModule_Screen" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function tells the Miva Merchant Admin what to display as main content when rendering the
SUTL screen.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="StoreUtilityModule_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant Admin calls this function when processing a form submission that includes Action=SUTL.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_util </MvCOMMENT>
<MvFUNCTION NAME="Module_Utility_Content" PARAMETERS="module var, tab, load_fields" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
This function renders content for visible tabs or hides state information for invisible tabs. If
tab is the code of one of the module’s tabs, the module should render whatever HTML content is
required for that specific tab. For all other tabs (or for all tabs if tab is not one of the
module’s tabs), the module should use hidden HTML <input> fields to maintain whatever state
information is required when a tab is not visible. Typically, this would involve creating hidden
input fields for each HTML form field which normally appears on an invisible tab. If load_fields
is true, the module should initialize all fields to a default value or current values for fields
provided on all tabs. Note: Error messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Utility_Head" PARAMETERS="module var, tab" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Store Utility
Settings screen. It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Utility_Tabs" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a list of tab codes and titles that are provided by the module.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Utility_Update" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function saves module-specific settings when the Update button is pressed. Note: Error
messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Utility_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs validation of module tab content. Note: Modules can call the FieldError
function to report invalid input fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> system </MvCOMMENT>
<MvFUNCTION NAME="SystemModule_Action" PARAMETERS="module var, action" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function for every form submit that passes an action value or list of
values. With this method, every system module is called for each action. Return Value: 1 on
success 0 on error -1 exits SystemModule_Action without performing default behavior
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="SystemModule_Screen" PARAMETERS="module var, screen" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when displaying a screen. Return Value 1 on success 0 on error
-1 exits SystemModule_Screen without performing default behavior
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="SystemModule_UIException" PARAMETERS="module var, exception" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function during a UI Exception. Return Value: 1 on success 0 on error -1
exits SystemModule_UIException without performing default behavior
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_system </MvCOMMENT>
<MvFUNCTION NAME="Module_System_Content" PARAMETERS="module var, tab, load_fields" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
This function renders content for visible tabs or hides state information for invisible tabs. If
tab is the code of one of the module’s tabs, the module should render whatever HTML content is
required for that specific tab. For all other tabs (or for all tabs if tab is not one of the
module’s tabs), the module should use hidden HTML <input> fields to maintain whatever state
information is required when a tab is not visible. Typically, this would involve creating hidden
input fields for each HTML form field which normally appears on an invisible tab. If load_fields
is true, the module should initialize all fields to a default value or current values for fields
provided on all tabs. Note: Error messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_System_Head" PARAMETERS="module var, tab" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the System Extension
Settings screen. It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_System_Tabs" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a list of tab codes and titles that are provided by the module.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_System_Update" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function saves module-specific settings when the Update button is pressed. Note: Error
messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_System_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs validation of module tab content. Note: Modules can call the FieldError
function to report invalid input fields. Utility
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> data_domain </MvCOMMENT>
<MvFUNCTION NAME="Module_Install" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when the administrator adds the module to the domain. One
employs this function only when the module performs some functionality or provides data that is
shared between all of the stores in a domain. The purpose of this function is to create any
databases and directories that may be required.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Uninstall" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when the administrator removes the module from the domain. It
should contain the code necessary to reverse what was done during Module_Install. Any action that
is taken in Module_Install should be reversed in this function. It could be deleting a database or
directory or deleting a user from the licensed-user database.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Upgrade" PARAMETERS="module var, version" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when the administrator clicks Update on the Edit Module
configuration screen. It provides a place to define what action admin must take to upgrade from
one version of the module to another. If the module has more than two versions that could be
actively used, there might be new fields in the later version of the module. In this case, the
databases would have to be upgraded carefully. For example, if there are four versions in use
(v1.0, v1.1, v2.0, v3.0) and you are upgrading from v1.0 to v3.0, the code should first upgrade to
v1.1, then to v2.0 and finally to v3.0.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_domain </MvCOMMENT>
<MvFUNCTION NAME="Module_Domain_Content" PARAMETERS="module var, tab, load_fields" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
This function renders content for visible tabs or hides state information for invisible tabs. If
tab is the code of one of the module’s tabs, the module should render required HTML content for
that specific tab. For all other tabs (or for all tabs if tab is not one of the module’s tabs),
the module should use hidden HTML <input> fields to maintain whatever state information is
required when a tab is not visible. Typically, this would involve creating hidden input fields for
each HTML form field which normally appears on an invisible tab. If load_fields is true, the
module should initialize all fields to a default value or current values for fields provided on
all tabs.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Domain_Head" PARAMETERS="module var, tab" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Domain Settings
screen. It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Domain_Tabs" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a list of tab codes and titles that are provided by the module.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Domain_Update" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function saves module-specific settings when the Update button is pressed. Note: Error
messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Domain_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs validation of module tab content.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> data_store </MvCOMMENT>
<MvFUNCTION NAME="Module_Install_Store" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when the store administrator assigns the module to the store.
The purpose of this function is to create any databases and directories that may be required by
the module for each store location.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Uninstall_Store" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when the store administrator removes a module from the store. It
should contain the code necessary to reverse what was done during Module_Install_Store. Every
action that is taken in Module_Install_Store should be reversed in this function. All databases
and directories that have been established should be deleted and the store should be taken out of
the “installed stores” database. Any other functions that were required to establish the store
must be reversed and cleaned up.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Upgrade_Store" PARAMETERS="module var, version" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when a store administrator clicks Update on the Edit Module
configuration screen. It provides a place for code altering the databases and directories that
apply to a specific store during an module upgrade.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_store </MvCOMMENT>
<MvFUNCTION NAME="Module_Store_Content" PARAMETERS="module var, tab, load_fields" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
This function renders content for visible tabs or hides state information for invisible tabs. If
tab is the code of one of the module’s tabs, the module should render whatever HTML content is
required for that specific tab. For all other tabs (or for all tabs if tab is not one of the
module’s tabs), the module should use hidden HTML <input> fields to maintain whatever state
information is required when a tab is not visible. Typically, this would involve creating hidden
input fields for each HTML form field which normally appears on an invisible tab. If load_fields
is true, the module should initialize all fields to a default value or current values for fields
provided on all tabs. Note: Error messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Store_Head" PARAMETERS="module var, tab" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Edit Store screen.
It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Store_Tabs" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a list of tab codes and titles that are provided by the module.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Store_Update" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function saves module-specific settings when the Update button is pressed. Note: Error
messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Store_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs validation of module tab content. Note: Modules can call the FieldError
function to report invalid input fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> log </MvCOMMENT>
<MvFUNCTION NAME="LogModule_Action" PARAMETERS="module var, action" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Shopping Interface Activity Logging
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="LogModule_Screen" PARAMETERS="module var, screen" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function after displaying a screen to the shopper.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="LogModule_UIException" PARAMETERS="module var, code" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function after processing a UI Exception, for example an error with the
input received from the shopper.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_log </MvCOMMENT>
<MvFUNCTION NAME="Module_Logging_Content" PARAMETERS="module var, tab, load_fields" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function renders content for visible tabs or hides state information for invisible tabs. If
tab is the code of one of the module’s tabs, the module should render whatever HTML content is
required for that specific tab. For all other tabs (or for all tabs if tab is not one of the
module’s tabs), the module should use hidden HTML <input> fields to maintain whatever state
information is required when a tab is not visible. Typically, this would involve creating hidden
input fields for each HTML form field which normally appears on an invisible tab. If load_fields
is true, the module should initialize all fields to a default value or current values for fields
provided on all tabs. Note: Error messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Logging_Head" PARAMETERS="module var, tab" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Logging Settings
screen. It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Logging_Tabs" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a list of tab codes and titles that are provided by the module.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Logging_Update" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function saves module-specific settings when the Update button is pressed. Note: Error
messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Logging_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs validation of module tab content. Note: Modules can call the FieldError
function to report invalid input fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> payment </MvCOMMENT>
<MvFUNCTION NAME="PaymentModule_Authorize" PARAMETERS="module var, code, total, pay_data var, secure_data var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0 -- Unsuported after 5.60
Note: This function has been deprecated and should only be used to ensure compatibility with older
versions of Miva Merchant. New modules should also implement PaymentModule_Runtime_Authorize().
This function authorizes payment. It is called during the checkout process to perform
modulespecific payment operations when an order is placed from the shopping interface. It is
called from the administrative interface when performing a payment operation using an obsolete
module.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_LeftNavigation" PARAMETERS="module var, indent" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function draws (optional) left navigation links. In 5.5 PR5 and later, payment module left
navigation links are displayed under the Utilities item. Items can be drawn using
LeftNavigation_Dot and LeftNavigation_Level.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Manipulate_Shipping" PARAMETERS="module var, code" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function allows a payment module to modify shipping charges or add handling charges. This
function is called by Action_PaymentManipulateShipping, which in a default installation is called
between Action_CalculateShipping and Action_CalculateTax.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Order_Authorize" PARAMETERS="module var, code, order var, amount" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.60
This function performs an authorization when requested through the administrative interface. When
called, the module should perform whatever operations are required when a new authorization is
created for an order from the administrative interface. Note: Error messages should be returned
through Error.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Order_Authorize_Field" PARAMETERS="module var, order var, pay_data, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
Miva Merchant calls this function when displaying payment information in the administrative
interface.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Order_Authorize_Fields" PARAMETERS="module var, order var, pay_data" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function defines the input fields required for an order in the administrative interface.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Order_Authorize_Hide_Additional_Fields" PARAMETERS="module var, order var, pay_data" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function hides module specific input fields — for example, fields that provide
configuration information and status to the external authorization process.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Order_Authorize_Invalid" PARAMETERS="module var, order var, pay_data, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function indicates whether or not invalid data has been entered on an order form.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Order_Authorize_Methods" PARAMETERS="module var, order var, methods var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
The administrative interface calls this function to display payment methods for order
authorization. It loads the l.methods structure with information about available payment methods
offered via this module, such as name and code.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.method_count }">
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Order_Authorize_Prompt" PARAMETERS="module var, order var, pay_data, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function provides a prompt for the field named in the field_id parameter originally named in
PaymentModule_Order_Authorize_Fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.text_prompt }">
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Order_Authorize_Validate" PARAMETERS="module var, order var, pay_data" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function validates payment fields in the administrative interface. When called, the module
verifies that all input fields drawn by PaymentModule_Order_Authorize_Field for the specified
payment method were filled out correctly, maintaining whatever internal state is required for
PaymentModule_Order_Authorize_Invalid to indicate specific fields that failed validation.
Typically, a payment module will not interact with an external gateway for this stage of the
validation and will instead report gateway errors when PaymentModule_Authorize or
PaymentModule_Runtime_Authorize is called.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Order_Content" PARAMETERS="module var, tab, load_fields, pay_data, secure_data" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
This function renders the content of a specific tab. If the current value of tab does not match
one or more of the module’s tabs, the content for those tabs should be output using hidden form
fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Order_Delete" PARAMETERS="module var, pay_data, secure_data" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is called when an Order is deleted. When an order containing multiple OrderPayment
records is deleted, this function is called for each OrderPayment within the Order. Note: Because
the order being deleted is not passed to the module as a parameter, the order must be inferred by
examining global variables. Refer to Appendix D: Deleting Orders on page 311 for further details.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Order_Head" PARAMETERS="module var, tab, order var" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Legacy Order
Processing and new Order Management tab screens. It is useful for outputting CSS styles or
external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_OrderPayment_Capture" PARAMETERS="module var, order var, auth_payment var, auth_pay_data var, auth_secure_data var, amou" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.60
This function performs a full or split capture of a previous authorization when requested through
the administrative interface. When called, the module should perform whatever operations are
required to capture the provided authorization. Note: Error messages should be returned through
Error.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_OrderPayment_Refund" PARAMETERS="module var, order var, capture_payment var, capture_pay_data var, capture_secure_data var, amount" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.60
This function performs a full or partial refund of a previous capture when requested through the
administrative interface. When called, the module should perform whatever operations are required
to refund the provided capture. Note: Error messages should be returned through Error.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_OrderPayment_VOID" PARAMETERS="module var, order var, auth_payment var, auth_pay_data var, auth_secure_data var, amount" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs a full or partial void of a previous authorization when requested through
the administrative interface. When called, the module should perform whatever operations are
required to void the provided authorization. Note: Error messages should be returned through Error.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Order_Tabs" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a string that identifies the tabs to be added to the default list of system
generated tabs. The string takes the following form:
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.code:tab_text }">
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Order_Update" PARAMETERS="module var, pay_data var, secure_data var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function updates content from module-provided order tab(s). It is called when an order is
updated using the legacy order processing or when data from a module-specific tab is saved.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Order_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function validates content on module-provided order tab(s). It is called when an order is
updated using the legacy order processing, or when data from a module-specific tab is saved.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Payment_Description" PARAMETERS="module var, code" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function describes a payment method provided by this module.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.description }">
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Payment_Field" PARAMETERS="module var, code, field_id" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
This function draws a checkout input field. When called, the module outputs any HTML required to
display the specified checkout field.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Payment_Fields" PARAMETERS="module var, code" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function defines input fields to be used during the checkout process.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.cvs_fieldlist }">
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Payment_Hide_Additional_Fields" PARAMETERS="module var, code" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function hides module-specific input fields. Payment modules that transfer control to an
external checkout process frequently need to pass additional hidden form fields which provide
configuration information and status to the external process. This function provides the module
with an opportunity to hide any additional form fields that need to be submitted when transferring
to the URL returned by PaymentModule_Payment_URL.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Payment_Invalid" PARAMETERS="module var, code, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function indicates whether a checkout field should be flagged as invalid.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Payment_Message" PARAMETERS="module var, code" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function allows an (optional) informational message to be displayed. If the function returns
a non-empty string, it is displayed prior to any payment fields during the checkout process.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.message }">
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Payment_Methods" PARAMETERS="module var, methods var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns an array of payment methods supported by this module.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.method_count }">
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Payment_Prompt" PARAMETERS="module var, code, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function provides a prompt for a checkout input field.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.text_prompt }">
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Payment_URL" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function provides support for external payment processing systems. If a payment module needs
to hand control of the checkout process to an external website, it may do so by returning a URL
from this function. If a URL is returned, the form in the checkout interface where payment
information is collected will be submitted to that URL rather than Miva Merchant.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.URL }">
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Payment_Validate" PARAMETERS="module var, code" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function validates checkout fields. When called, the module should verify that all input
fields drawn by PaymentModule_Payment_Field for the specified payment method were filled out
correctly maintaining whatever internal state is required for PaymentModule_Payment_Invalid to
indicate specific fields that failed validation. Typically, a payment module will not interact
with an external gateway for this stage of the validation, and will instead report gateway errors
when PaymentModule_Authorize or PaymentModule_Runtime_Authorize is called.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Process" PARAMETERS="module var, pay_data var, secure_data var, order var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.6 -- Unsuported after 5.60
This function captures payment information. It is called when processing orders using the legacy
order processing interface or when capturing a legacy authorization from the administrative
interface. Information regarding the state of the shopping session may be obtained from the global
variable Basket. Note: This function has been deprecated and should only be used to ensure
compatibility with older versions of Miva Merchant. New modules should also implement
PaymentModule_OrderPayment_Capture. Note: Descriptive error messages may be reported by calling
Message_Error.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Report_Description" PARAMETERS="module var, pay_data" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function provides a textual description of a payment record for reports.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.description }">
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Report_Fields" PARAMETERS="module var, pay_data, secure_data" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function defines transaction fields to be displayed in reports and order detail.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.csv_fieldlist }">
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Report_Label" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function provides a label for a field displayed in reports and order detail.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.text_label }">
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Report_Value" PARAMETERS="module var, field_id, pay_data, secure_data" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function provides a value for a field displayed in reports and order detail.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.value }">
</MvFUNCTION>
<MvFUNCTION NAME="PaymentModule_Runtime_Authorize" PARAMETERS="module var, code, total" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.60
This function performs an authorization when an order is created through the shopping interface.
When called, the module should perform whatever operations are desired when an order is placed
within the shopping interface and create one or more OrderPayment records reflecting the results.
Information regarding the state of the shopping session may be obtained from the global variable
Basket. Note: Modules that implement this function should still implement PaymentModule_Authorize
for interoperability. Note: Descriptive error messages may be reported by calling Message_Error.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_payment </MvCOMMENT>
<MvFUNCTION NAME="Module_Payment_Content" PARAMETERS="module var, tab, load_fields" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
This function renders content for visible tabs or hides state information for invisible tabs. If
tab is the code of one of the module’s tabs, the module should render whatever HTML content is
required for that specific tab. For all other tabs (or for all tabs if tab is not one of the
module’s tabs), the module should use hidden HTML <input> fields to maintain whatever state
information is required when a tab is not visible. Typically, this would involve creating hidden
input fields for each HTML form field which normally appears on an invisible tab. If load_fields
is true, the module should initialize all fields to a default value or current values for fields
provided on all tabs. Note: Error messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Payment_Head" PARAMETERS="module var, tab" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Payment Settings
screen. It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Payment_Tabs" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a list of tab codes and titles that are provided by the module.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Payment_Update" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function saves module-specific settings when the Update button is pressed. Note: Error
messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Payment_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs validation of module tab content. Note: Modules can call the FieldError
function to report invalid input fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> shipping </MvCOMMENT>
<MvFUNCTION NAME="ShippingModule_Basket_Methods" PARAMETERS="module var, packages var, package_count, methods var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function replaces ShippingModule_Shipping_Methods in version 5.71 API or higher modules. Its
purpose is to generate a list of shipping methods, complete with rate information, that will be
presented to the shopper at checkout. The current shopping basket is always stored in the global
variable g.Basket (as with ShippingModule_Shipping_Methods). Note: Depending on the caller, error
messages are usually not reported.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.method_count }">
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Calculate_Basket" PARAMETERS="module var, data" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is called to apply a shipping method provided by the module to the current basket.
The module should recalculate or retrieve the previously calculated shipping rate for the
indicated method from the BasketInfo mechanism, then create the appropriate BasketCharge database
table entries to reflect the calculated shipping rate.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Description" PARAMETERS="module var, data" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is called to retrieve a user-friendly description of a shipping method.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.text_description }">
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Enabled_Methods" PARAMETERS="module var, methods var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.61
This function loads a list of enabled shipping methods that the module can return regardless of
basket contents.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.method_count }">
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Order_Content" PARAMETERS="module var, tab, load_fields" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is called to display the content of an Order tab from the list returned by
ShippingModule_Order_Tabs. When the tab parameter matches one of the tabs drawn by this module, it
draws the controls (using HTML) meant to be visible on the tab. When the tab parameter does not
match, the module hides any input values in HTML hidden <input> tags.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Order_Delete" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is called when an order is deleted for the shipping module associated with that
order (selected during the checkout process), giving the shipping module a chance to delete any
records it may have stored related to that order. Note: Because the order being deleted is not
passed to the module as a parameter, the order must be inferred by examining global variables.
Refer to Appendix D: Deleting Orders on page 311 for further details.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Order_Head" PARAMETERS="module var, tab, order var" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Legacy Order
Processing Edit Order screen and module-specific order tabs in the new Order Management interface.
It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Order_Tabs" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is called for the shipping module associated with an order to determine what (if
any) additional order tabs should be visible when reviewing the order. ShippingModule_Order_Tabs
returns a string that identifies the tabs to be added to the default list of system-generated
tabs. The string takes the following form: <code>:<Description>,<code2>:<Description2> The module
may specify as many <code>:<Description> pairs as it likes by separating them with commas. A new
tab will be drawn for each pair. If the module returns an empty string, no additional tabs are
drawn.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Order_Update" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
Admin calls this function when Update is selected on the Edit Order configuration screen.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Order_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin calls this function to validate fields when a user selects Update on the Edit Order
configuration screen.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Report_Fields" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin calls this function when displaying a standard batch report. It returns a comma separated
list of field identifiers for fields displayed in the batch report.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.CSV_fieldlist }">
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Report_Label" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin calls this function when displaying a standard batch report. It returns a string for use as
visible text for display beside the field identified by field_id.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.text_label }">
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Report_Value" PARAMETERS="module var, field_id, data" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin calls this function when displaying a standard batch report. It returns the value to display
in the field identified by field_id for the method identified in data.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.text_value }">
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Shipping_Methods" PARAMETERS="module var, methods var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0 -- Unsupported after 5.71
This function generates a list of shipping methods, complete with rate information, that will be
presented to the shopper at checkout. The current shopping basket is always stored in the global
variable g.Basket (as with ShippingModule_Basket_Methods). Note: This function has been deprecated
and should only be used to ensure compatibility with older versions of Miva Merchant. New modules
should also implement ShippingModule_Basket_Methods.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.method_count }">
</MvFUNCTION>
<MvCOMMENT> vis_shipping </MvCOMMENT>
<MvFUNCTION NAME="Module_Shipping_Content" PARAMETERS="module var, tab, load_fields" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
the code of one of the module’s tabs, the module should render whatever HTML content is required
for that specific tab. For all other tabs (or for all tabs if tab is not one of the module’s
tabs), the module should use hidden HTML <input> fields to maintain whatever state information is
required when a tab is not visible. Typically, this would involve creating hidden input fields for
each HTML form field which normally appears on an invisible tab. If load_fields is true, the
module should initialize all fields to a default value or current values for fields provided on
all tabs. Note: Error messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Shipping_Head" PARAMETERS="module var, tab" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Shipping Settings
screen. It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Shipping_Tabs" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a list of tab codes and titles that are provided by the module.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Shipping_Update" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function saves module-specific settings when the Update button is pressed. Note: Error
messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Shipping_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs validation of module tab content. Note: Modules can call the FieldError
function to report invalid input fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> fulfill </MvCOMMENT>
<MvFUNCTION NAME="FulfillmentModule_ProcessOrder" PARAMETERS="module var, order var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function after a successful run of PaymentModule_Authorize. At a basic
level, it can be used to send the customer an order acknowledgement email, or it can send the
customer an invoice and the shipping department a packing list. For more advanced order
processing, FulfillmentModule_ProcessOrder can, for example, send a parts list that defines the
components necessary for a custom built computer to the manufacturing floor.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_fulfill </MvCOMMENT>
<MvFUNCTION NAME="Module_Fulfillment_Content" PARAMETERS="module var, tab, load_fields" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
This function renders content for visible tabs or hides state information for invisible tabs. If
tab is the code of one of the module’s tabs, the module should render whatever HTML content is
required for that specific tab. For all other tabs (or for all tabs if tab is not one of the
module’s tabs), the module should use hidden HTML <input> fields to maintain whatever state
information is required when a tab is not visible. Typically, this would involve creating hidden
input fields for each HTML form field which normally appears on an invisible tab. If load_fields
is true, the module should initialize all fields to a default value or current values for fields
provided on all tabs. Note: Error messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Fulfillment_Head" PARAMETERS="module var, tab" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Order Fulfillment
Settings screen. It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Fulfillment_Tabs" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a list of tab codes and titles that are provided by the module.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Fulfillment_Update" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function saves module-specific settings when the Update button is pressed. Note: Error
messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Fulfillment_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs validation of module tab content. Note: Modules can call the FieldError
function to report invalid input fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> import </MvCOMMENT>
<MvFUNCTION NAME="ImportModule_Capabilities" PARAMETERS="module var, capabilities var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function allows the module to tell the import subsystem what functionality it implements.
Modules with an API version lower than 5.70 are assumed to have the following capabilities:
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Delimited_Columns" PARAMETERS="module var, import var, columns var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
For modules that import the :persistent capability with a :format of “delimited”, this
function defines the list of input columns that the module expects. The import subsystem will use
this list of columns to provide the configuration user interface and also to perform column-header
based automatic mapping of fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.column_count }">
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Delimited_Import_Begin" PARAMETERS="module var, import var, session var, run_data var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function is called when the import of a delimited file is begun. It allows the module to
perform any import initialization, validation of auto-mapped columns or other pre-import
operations that may be required.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Delimited_Import_End" PARAMETERS="module var, import var, session var, run_data var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function is called at the end of a delimited import to allow the module to perform any
cleanup tasks that may be required.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Delimited_Import_Record" PARAMETERS="module var, import var, session var, record var, run_data var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
During a delimited import, this function is called once for each record.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Import" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when a user submits information from the Import UI screen in the
administration tool. This function provides the Admin with instructions about importing the data
to a Miva Merchant database from a database or file outside of the Miva Merchant environment. For
example, this type of module could read a product database outside of Miva Merchant and write it
to the Miva Merchant products database. Any data in the Miva Merchant database can be imported.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Persistent_Field" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.70
This function draws a single configuration field.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Persistent_Fields" PARAMETERS="module var, import var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function returns a comma separated list of field identifiers that are used to draw the
configuration dialog for this import. Each identifier receives a single row in the configuration
dialog, with each row consisting of a “prompt” (descriptive text to the left of the field) and
a “field” (input controls, etc.)
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.CSV_fieldlist }">
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Persistent_Invalid" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
When ImportModule_Persistent_Validate fails, this function is called for each field to determine
whether the field should be displayed in an invalid state. Presently this means that the field’s
prompt is displayed in red text.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Persistent_Prompt" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function returns the prompt (descriptive text displayed to the left of the field) for a
single field from the list of fields returned by ImportModule_Persistent_Fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.textual_prompt }">
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Persistent_Provision" PARAMETERS="module var, import var, settings_xml var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function performs configuration provisioning of a persistent import. Note: The current
version of the software only supports creation of persistent imports through provisioning and does
not allow updates of existing imports. Important: If 0 is returned, the import subsystem will
abort creation of the provisioned import. Note: The module should report provisioning warnings or
errors using PRV_LogMessage or PRV_LogError.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Persistent_StatusFields" PARAMETERS="module var, import var, status_fields var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
While processing an import file, the import subsystem allows modules to define module-specific
status fields that are displayed to the user. This function describes the status fields provided
by the module. Note: During the import process, modules may control the values of the status
fields by using the Import_Session_StatusField_XXX functions provided in features/imp/imp_ut.mv.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.status_field_count }">
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Persistent_Update" PARAMETERS="module var, import var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.70
This function is called to update the module-specific configuration settings of a persistent import.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Persistent_Validate" PARAMETERS="module var, import var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function is called to validate the configuration fields defined by ImportModule_Fields. Note:
Modules may report validation errors through ImportModule_Persistent_Invalid or by calling the
FieldError function
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Raw_Import_Begin" PARAMETERS="module var, import var, session var, filename, run_data var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function is called at the beginning of a persistent import using the “raw” format. It
allows the module to perform any start-of-import initialization that is required.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Raw_Import_Deserialize" PARAMETERS="module var, import var, session var, filename, run_data var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
In order to prevent timeouts, the import subsystem will occasionally suspend and resume the import
process. For delimited imports, this behavior is handled behind the scenes and requires no special
handling in the import module. For raw imports, the import subsystem provides the functions
ImportModule_Raw_Import_Serialize and ImportModule_Raw_Import_Deserialize to allow the module to
save any state information that would be lost when the current script terminates and a new script
is executed (for example, xml_parse_section internal state). When the session needs to be
suspended, the import subsystem calls ImportModule_Raw_Import_Serialize. The module should perform
whatever tasks are necessary to retain its state, storing any data in the run_data parameter. When
the import process resumes, ImportModule_Raw_Import_Deserialize will be called, with the same
values in run_data, allowing the module to restore its state information (resume an xml_parse,
etc.).
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Raw_Import_End" PARAMETERS="module var, import var, session var, filename, run_data var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function is called at the conclusion of a raw import to allow the module to perform any
post-import cleanup that is required.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Raw_Import_Record" PARAMETERS="module var, import var, session var, filename, run_data var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function is called to perform the actual import operations. The import subsystem will call
this function repeatedly until it returns -1 (indicating that the import is complete), or 0
(indicating an error). Note: The import module is expected to use the run_data parameter to
maintain variables allowing it to track its current position within the file or the internal state
of the import operation.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Raw_Import_Serialize" PARAMETERS="module var, import var, session var, filename, run_data var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
In order to prevent timeouts, the import subsystem will occasionally suspend and resume the import
process. For delimited imports, this behavior is handled behind the scenes and requires no special
handling in the import module. For raw imports, the import subsystem provides the functions
ImportModule_Raw_Import_Serialize and ImportModule_Raw_Import_Deserialize to allow the module to
save any state information that would be lost when the current script terminates and a new script
is executed (for example, xml_parse_section internal state). When the session needs to be
suspended, the import subsystem calls ImportModule_Raw_Import_Serialize. The module should perform
whatever tasks are necessary to retain its state, storing any data in the run_data parameter. When
the import process resumes, ImportModule_Raw_Import_Deserialize will be called, with the same
values in run_data, allowing the module to restore its state information (resume an xml_parse,
etc.).
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Screen" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when a user submits information from the Import UI screen in the
administration tool (by clicking the module’s link under Utilities > Import Data in the Admin
left menu pane). It provides Admin with instructions on how to build a UI screen for the module.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ImportModule_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when a user submits information from the Import UI screen in the
administration tool. This function provides a place for code to validate any input data that is
required to run the module. For example, if the module requires a database name and the fields to
be imported, this function must validate that the names of the database and fields exist and can
be written to.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> export </MvCOMMENT>
<MvFUNCTION NAME="ExportModule_Export" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when a user submits information from the Export UI screen in the
administration tool. This function provides a place for code to validate any input data that is
required to run the module. For example, if the module requires a database name and the fields to
be exported, this function must validate that the names of the database and fields exist and can
be read.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ExportModule_Screen" PARAMETERS="module var" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when a user submits information from the Export UI screen in the
administration tool. This function provides the Admin with instructions about exporting data in a
Miva Merchant database or file to a database or file outside of the Miva Merchant environment. For
example, this type of module could read the customer database and write it to a file on another
computer. Any data that is available to Miva Merchant can be exported.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ExportModule_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when a user submits information from the Export UI screen in the
administration tool. This function provides a place for code to validate any input data that is
required to run the module. For example, if the module requires a database name and the fields to
be exported, this function must validate that the names of the database and fields exist and can
be read.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> batchreport </MvCOMMENT>
<MvFUNCTION NAME="BatchReportModule_Order_Reports" PARAMETERS="module var, reports var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function returns a list of order reports to Miva Merchant generated by this module. The
module puts information about each supported report into the reports parameter.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.reports_count }">
</MvFUNCTION>
<MvFUNCTION NAME="BatchReportModule_Report" PARAMETERS="module var, batch_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
The BatchReportModule_Report generates an order batch report. The module determines the format and
content of the output. Typically, a module would load a list of Order records using
OrderList_Load_Batch(). Examples of implementations of BatchReportModule_Report can be found in
the modules/batch directory.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="BatchReportModule_Run_OrderList" PARAMETERS="module var, report_code, orders var, order_count" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.7
This function is called to generate and output a report on a particular list of orders. The orders
can be loaded from an order batch or directly selected by the user. The module generates whatever
content is appropriate for the report using the specified orders.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="BatchReportModule_Run_ShipmentList" PARAMETERS="module var, report_code, shipments var, shipment_count" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.7
This function is called to generate and output a report on a particular list of shipments. The
shipments can be loaded from a shipment batch or directly selected by the user. The module
generates whatever content is appropriate for the report using the specified shipments.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="BatchReportModule_Shipment_Reports" PARAMETERS="module var, reports var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.7
Returns a list of shipment reports to Miva Merchant generated by this module. The module puts
information about each supported report into the reports parameter.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.reports_count }">
</MvFUNCTION>
<MvCOMMENT> currency </MvCOMMENT>
<MvFUNCTION NAME="CurrencyModule_AddFormatPlainText" PARAMETERS="module var, value" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function provides alternate formatting to the CurrencyModule_AddFormatting function. It is
intended for use by email modules. Examples of implementations of
CurrencyModule_AddFormatPlainText can be found in the modules/currency directory.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.formatted_amt }">
</MvFUNCTION>
<MvFUNCTION NAME="CurrencyModule_AddFormatPlainTextShort" PARAMETERS="module var, value" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function provides alternate formatting to the CurrencyModule_AddFormatting function. It is
intended for use by email modules. Examples of implementations of
CurrencyModule_AddFormatPlainTextShort can be found in the modules/currency directory.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.formatted_amt }">
</MvFUNCTION>
<MvFUNCTION NAME="CurrencyModule_AddFormatting" PARAMETERS="module var, value" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function wherever it displays a price on one of the store pages. Miva
Merchant will call this function only from the currency module selected by the store administrator
using the Edit Store configuration screen. Examples of implementations of
CurrencyModule_AddFormatting can be found in the modules/currency directory.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.formatted_amt }">
</MvFUNCTION>
<MvCOMMENT> component </MvCOMMENT>
<MvFUNCTION NAME="ComponentModule_Content" PARAMETERS="module var, item, tab, load_fields, field_prefix, fields var, settings var" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
ComponentModule_Content runs when the Admin displays the Edit Page configuration screen for a page
using an Item based on the component. It tells the Admin what to display on the Edit Page screen
when the user selects the tab belonging to this module. Examples of implementations of
ComponentModule_Content can be found in the modules/component directory.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ComponentModule_Defaults" PARAMETERS="module var, settings var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin calls this function when you assign a corresponding item to a page. Examples of
implementations of ComponentModule_Defaults can be found in the modules/component directory.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="ComponentModule_Initialize" PARAMETERS="module var, item, all_settings var, settings var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when displaying a page using an item based on the component. Use
this function to add, delete, or edit values in the settings and all_settings structures that
contain the data for display on the page (e.g., product name, list of shipping methods). Miva
Merchant will call this function sequentially from any component extending the first component,
for example, to add to the product name, or alter the order of the shipping methods in the list.
Examples of implementations of ComponentModule_Initialize can be found in the modules/ component
directory.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ComponentModule_Page_Assign" PARAMETERS="module var, page var, item, settings var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin calls this function when you assign a corresponding item to a page. Examples of
implementations of ComponentModule_Page_Assign can be found in the modules/component directory.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ComponentModule_Page_Unassign" PARAMETERS="module var, page var, item, settings var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin calls this function when you unassign an item from a page. Examples of implementations of
ComponentModule_Page_Unassign can be found in the modules/component directory.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ComponentModule_Prerender" PARAMETERS="module var, item, all_settings var, settings var, param" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.72 -- PR8 Update 5
This function is called before ComponentModule_Render_Start to allow modules to separate their
in-render loading activities from the actual output of content. This provides a mechanism similar
to ComponentModule_Initialize, but with the ability to see the param value which will be passed to
ComponentModule_Render. ComponentModule_Prerender is called when an item is explicitly
pre-rendered through the Template Manager’s TemplateManager_Component_Prerender function or
immediately before calling ComponentModule_Render_Start.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="ComponentModule_Render_End" PARAMETERS="module var, item, all_settings var, settings var, param" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
Admin calls this function when the Template Manager encounters an item end tag (<mvt:item />) in
the template. The function tells Miva Merchant what HTML source to place at that point on the
page. Examples of implementations of ComponentModule_Render_End can be found in the
modules/component directory.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="ComponentModule_Render_Start" PARAMETERS="module var, item, all_settings var, settings var, param" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
Admin calls this function when the Template Manager encounters an item start tag (<mvt:item>) in
the template. The function tells Miva Merchant what HTML source to place at that point on the
page. Examples of implementations of ComponentModule_Render_Start can be found in the
modules/component directory.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="ComponentModule_Tabs" PARAMETERS="module var, item, settings var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when Admin displays an Edit Page configuration screen for a page
using an item based on the component. It returns a string of the tabs that the component will
generate. The string takes the following form: <code>:<title>,<code2>,<title2> The module may
specify as many <code>:<title> pairs as it likes by separating them with commas. A new tab will be
drawn for each pair. If the module returns an empty string, no additional tabs are drawn.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="ComponentModule_Update" PARAMETERS="module var, item, field_prefix, fields var, settings var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when Update is selected on the Edit Page configuration screen
for a page using an item based on the component. Examples of implementations of
ComponentModule_Update can be found in the modules/component directory.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ComponentModule_Validate" PARAMETERS="module var, item, field_prefix, fields var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when Validate is selected on the Edit Page configuration screen
for a page using an item based on the component. Examples of implementations of
ComponentModule_Validate can be found in the modules/component directory.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> discount </MvCOMMENT>
<MvFUNCTION NAME="DiscountModule_Capabilities" PARAMETERS="module var, capabilities var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 9.01 -- Miva Merchant 9
This function describes the functionality that the discount module provides to the discount
subsystem.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="DiscountModule_Discount_Basket" PARAMETERS="module var, pricegroup var, discount_state var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 9.01 -- Miva Merchant 9
This function is called after all the items are discounted for modules that have the “basket”
capability. For example, the basket.mv module uses this function to apply basket-wide discounts
instead of line item discounts.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="DiscountModule_Field" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 9.01 -- Miva Merchant 9
This function draws the HTML input element(s) required for configuration of a single field from
the list returned by DiscountModule_Fields. The module outputs the required HTML directly.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="DiscountModule_Fields" PARAMETERS="module var, pricegroup var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 9.01 -- Miva Merchant 9
This function returns a comma separated list of field identifiers for module-specific fields that
should be present for a given price group.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.CSV_fields }">
</MvFUNCTION>
<MvFUNCTION NAME="DiscountModule_Invalid" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 9.01 -- Miva Merchant 9
When DiscountModule_Invalid returns 0, this function is called for each field to determine which
field(s) should be displayed in the invalid state.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="DiscountModule_PriceGroup_Delete" PARAMETERS="module var, pricegroup var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 9.01 -- Miva Merchant 9
This function notifies the module that a price group is being deleted. When a price group is
deleted, the database layer calls this function in order to give the module an opportunity to
delete any records associated with the price group.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="DiscountModule_Prompt" PARAMETERS="module var, pricegroup var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 9.01 -- Miva Merchant 9
This function is called for each field return by DiscountModule_Fields to obtain the prompt
(descriptive text displayed to the left of the field).
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.prompt }">
</MvFUNCTION>
<MvFUNCTION NAME="DiscountModule_Provision_Settings" PARAMETERS="module var, pricegroup var, provide_xml var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 9.01 -- Miva Merchant 9
This function is called when a price group is created using the PriceGroup_Add provisioning tag
and the <Settings> tag is present. The module is expected to implement provisioning for whatever
settings are normally maintained on a price-group by price-group basis.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="DiscountModule_Update" PARAMETERS="module var, pricegroup var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 9.01 -- Miva Merchant 9
This function is called when a price group is modified so that the module can store any changes to
the module controlled price group fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="DiscountModule_Validate" PARAMETERS="module var, pricegroup var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 9.01 -- Miva Merchant 9
This function is called to validate module-provided price group fields when creating or updating a
price group record from the administrative interface.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> tax </MvCOMMENT>
<MvFUNCTION NAME="TaxModule_Calculate_Basket" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when responding to a form submission from the shopper containing
Action = CTAX. This function should contain the instructions necessary to insert a ‘TAX’
basket charge in the basket.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="TaxModule_Order_Field" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function creates the HTML code needed to display the tax field identified by the field_id
parameter (set in TaxModule_Order_Fields). Return Value: 1 if HTML is output 0 if nothing is set
Note: The return value is ignored by Miva Merchant.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="TaxModule_Order_Fields" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
The Miva Merchant UI calls this function at each checkout screen to determine which, if any, tax
fields to display Return Value: A comma separated list of field identifiers of the form:
id[,id,id,id-]
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.CSV_fieldlist }">
</MvFUNCTION>
<MvFUNCTION NAME="TaxModule_Order_Hide_Fields" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
The Miva Merchant UI calls this function when displaying the OSEL screen. The purpose of this
function is to insert hidden fields on checkout screens to carry data through, as form variables,
from earlier screens (such as OINF) through later screens (such as OSEL) until the shopper is able
to submit a form with Action = CTAX.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="TaxModule_Order_Invalid" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
The Miva Merchant UI consults this function to determine whether to highlight a given field to
indicate that the last information the shopper entered in that field was invalid. The function
itself may make that determination based on an invalidity flag set in TaxModule_Order_Validate.
The strategy is the same as used for PaymentModule_Payment_Invalid and
PaymentModule_Payment_Validate.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="TaxModule_Order_Prompt" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a text string for display beside the tax field identified by the field_id
parameter (set in TaxModule_Order_Fields).
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.prompt }">
</MvFUNCTION>
<MvFUNCTION NAME="TaxModule_Order_Required" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
The Miva Merchant UI consults this function to determine whether or not a field needs validation,
such as would be necessary to make sure that the shopper made a selection on a field.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="TaxModule_Order_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls Action_Save_OrderInformation in response to a form submission containing
Action=ORDR, as is the case with the form shoppers submit from the OINF page. The function
provides an opportunity to check if the tax information is acceptable. One use is to set
invalidity flags for consultation by TaxModule_Order_Invalid. TaxModule_Order_Invalid can check
the status of a given flag (for example, an ID number) and decide whether to declare the
submission invalid on that basis. (For another implementation of the same strategy, see
PaymentModule_Payment_Validate and PaymentModule_Payment_Invalid.) If the function returns 0, the
UI will return to the previous page. The UI will know from the invalidity flags that the previous
submissions were invalid and it will highlight the relevant input fields appropriately.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="TaxModule_ProcessOrder" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function after creating an order but before calling
FulfillmentModule_Process_Order. The function provides an opportunity to perform operations at the
time the shopper places the order, such as calculating taxes in real time.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> json </MvCOMMENT>
<MvFUNCTION NAME="Module_JSON" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.72 -- PR8 Update 5
This function is called when a module function is requested through json.mvc. By convention, the
module-specific function will be indicated by g.Module_Function, but it is not required. The
module should do whatever operation the function entails, outputting a valid JSON formatted
response formatted using the helper functions in json.mv.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvCOMMENT> provision_store </MvCOMMENT>
<MvFUNCTION NAME="Module_Provision_Store" PARAMETERS="module var, provide_xml var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function allows a module to extend the Miva Merchant XML provisioning language to support
functionality specific to the module. Module specific provisioning functions are triggered by the
<Module> provisioning tag. The module should use the PRV_LogMessage or PRV_LogError functions in
features/prv/prv_ad.mvc to report errors.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvCOMMENT> boxpacking </MvCOMMENT>
<MvFUNCTION NAME="BoxPackingModule_Box_Delete" PARAMETERS="module var, box_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function is called when a box is deleted to allow the module to clean up any data that
references the box.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="BoxPackingModule_Box_Field" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function draws HTML input element(s) required for configuration of a single field from the
list returned by BoxPackingModule_Box_Fields. The module should output the required HTML directly.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="BoxPackingModule_Box_Fields" PARAMETERS="module var, box var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function returns a comma separated list of the field identifiers for module-specific fields
that should be present for a given box.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.CS_fields }">
</MvFUNCTION>
<MvFUNCTION NAME="BoxPackingModule_Box_Insert" PARAMETERS="module var, box var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function is called when a new box is created so that the module can store any module
controlled box fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="BoxPackingModule_Box_Invalid" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
When BoxPackingModule_Box_Validate returns 0, this function is called for each field to determine
which field(s) should be displayed in the invalid state.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="BoxPackingModule_Box_Prompt" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function is called for each field returned by BoxPackingModule_Box_Fields to obtain the
prompt (descriptive text displayed to the left of the field).
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.textual_prompt }">
</MvFUNCTION>
<MvFUNCTION NAME="BoxPackingModule_Box_Provision" PARAMETERS="module var, box var, provide_xml var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function is called when a box is created using the Box_Add provisioning tag and the
<BoxPackingSettings> tag is present. The module is expected to implement provisioning for whatever
settings are normally maintained on a box-by-box basis. Important: All boxpacking modules must
implement this function. None. This function must not return a value. Provisioning errors should
be logged using PRV_LogMessage or PRV_LogError.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="BoxPackingModule_Box_Update" PARAMETERS="module var, box var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function is called when a box is modified so that the module can store any changes to the
module controlled box fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="BoxPackingModule_Box_Validate" PARAMETERS="module var, box var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function is called to validate module-provided box fields when creating or updating a box
record from the administrative interface. Return Value: 1 if all module-provided fields are valid
2 if any module-provided field is invalid. Note: Validation failures may be reported via
BoxPackingModule_Box_Invalid or by calling the FieldError function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.1 or 2 }">
</MvFUNCTION>
<MvFUNCTION NAME="BoxPackingModule_Box_Items" PARAMETERS="module var, items var, item_count, packages var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function is called to build a packaging solution using currently enabled boxes for a
specified set of items. Note: Multiple quantities of the same item are expanded and will be
represented by multiple items in the items array.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.entries_count }">
</MvFUNCTION>
<MvCOMMENT> vis_pkgrules </MvCOMMENT>
<MvFUNCTION NAME="Module_PackagingRules_Content" PARAMETERS="module var, tab, load_fields" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
This function renders content for visible tabs or hides state information for invisible tabs. If
tab is the code of one of the module’s tabs, the module should render HTML content required for
that specific tab. For all other tabs (or for all tabs if tab is not one of the module’s tabs),
the module should use hidden HTML <input> fields to maintain information required when tab is not
visible.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_PackagingRules_Head" PARAMETERS="module var, tab" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.0
This function allows the module to output content in the HTML <head> tag of the Packaging Rules
screen. It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_PackagingRules_Tabs" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a list of tab codes and titles that are provided by the module. These tabs
will be added to the Packaging Rules screen.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_PackagingRules_Update" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function performs module-specific actions when package rules are updated.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_PackagingRules_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs validation of tab content when a package rule is updated.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> wizard </MvCOMMENT>
<MvFUNCTION NAME="WizardModule_Action" PARAMETERS="module var" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
Admin calls this function after the user completes all steps and after a successful return from
WizardModule_Privileges and WizardModule_Validate. Intructions can be placed here regarding what
to do with or in reaction to the input submitted by the user.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="WizardModule_Content" PARAMETERS="module var, step, load_fields" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin calls this function each time it displays a new screen. It provides the instructions for the
main portion of the wizard screen. Note: Error messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="WizardModule_Icon" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is used to define the path and name of the icon graphic that is displayed on the
admin.mv front page under the Domain section.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="WizardModule_Logo" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is used to define the path and name of the icon graphic that displays in the upper
left corner of the wizard. Admin calls this function each time it displays a new screen.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="WizardModule_Privileges" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin calls this function when it builds its left menu.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="WizardModule_Title" PARAMETERS="module var, step" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin calls this function each time it displays a new screen.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.title }">
</MvFUNCTION>
<MvFUNCTION NAME="WizardModule_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin calls this function after the user completes all steps. Instructions should be included in
the function to determine that any information the administrator submits is acceptable in format.
Note: Modules can call the FieldError function to report invalid input fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="WizardModule_Validate_Step" PARAMETERS="module var, step" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin calls this function each time it receives input from the submission of a wizard screen (one
screen per step). Instructions should be included in the function to determine that any
information the administrator submits is acceptable in format. Note: Invalidity flags can be set
for use by the UI in a fashion similar to that of PaymentModule_Payment_Invalid.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> component_prov </MvCOMMENT>
<MvFUNCTION NAME="ComponentModule_Provision" PARAMETERS="module var, provide_xml var, settings var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin calls this function when it processes the provide.xml file if it encounters a tag
identifying this module: <Module code=[code for this module]>. Admin then passes the information
contained by the tag to the function. The function can then perform its task — for example,
writing data to the appropriate database table. In addition, it receives the item settings.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_wizard </MvCOMMENT>
<MvFUNCTION NAME="Module_Is_Wizardable" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is called when the payment, shipping, or sales tax wizard is launched. It determines
which modules of the corresponding feature types to include in the module selection drop-down lists.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Wizard_Action" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin calls this function after the user completes all of a module’s wizard steps and after a
successful return from Module_Wizard_Validate. Instructions can be placed here regarding what to
do with or in response to the input submitted by the user.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Wizard_Content" PARAMETERS="module var, step, load_fields" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
Admin calls this function each time it displays a new step for a module’s wizard. Note: Error
messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Wizard_Summary_Field" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function renders the value of the field identified by the field_id parameter received from
the list set in Module_Wizard_Summary_Fields. For example, it can be used to fill in a table
listing each of the tax rates entered by the administrator during use of the wizard.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Wizard_Summary_Fields" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Wizard modules make use of this function along with Module_Wizard_Summary_Prompt and
Module_Wizard_Summary_Field to create a table displaying the inputs provided by the administrator
over the course of using the wizard.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.CSV_fieldlist }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Wizard_Summary_Prompt" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a text string for use as a field label or table heading. The value of the
prompt is dependent upon the field_id parameter, received from the list set in
Module_Wizard_Summary_Fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.field_prompt }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Wizard_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin calls this function after the user completes all of the module’s wizard steps.
Instructions should be included in the function to insure that the information the user submits is
in an acceptable format. Note: Modules can call the FieldError function to report invalid input
fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Wizard_Validate_Step" PARAMETERS="module var, step" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is called after each step of a module’s wizard is submitted. It provides a way to
validate the data from each step as the user proceeds through the wizard instead of validating all
of the steps at once at the end.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> custrt </MvCOMMENT>
<MvFUNCTION NAME="Module_Customer_Runtime_ChangeEmailAddress" PARAMETERS="module var, customer var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.73 -- PR8 Update 7
This function is called by Miva Merchant when a customer successfully completes an email address
change operation. This allows modules using the custrt feature to make their own internal changes
when a customer changes their email address.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_Runtime_ChangePassword" PARAMETERS="module var, customer var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.73 -- PR8 Update 7
This function is called by Miva Merchant when a customer successfully completes a password change
operation. This allows modules using the custrt feature to make their own internal changes when a
customer changes their password.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_Runtime_Insert" PARAMETERS="module var, customer var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when a customer creates a new customer account at runtime.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_Runtime_Update" PARAMETERS="module var, customer var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when a customer updates a customer account at runtime.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_Runtime_Validate" PARAMETERS="module var, customer var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when a customer record requires validation at runtime.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_affil </MvCOMMENT>
<MvFUNCTION NAME="Module_Affiliate_Content" PARAMETERS="module var, tab, load_fields, affiliate var" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
This function renders content for visible tabs or hides state information for invisible tabs. If
affiliate:id is 0, the system is requesting tabs for the Add Affiliate screen. Otherwise, tabs are
being requested for the Edit Affiliate screen and affiliate will contain the record being edited.
If tab is the code of one of the module’s tabs, the module should render whatever HTML content
is required for that specific tab. For all other tabs (or for all tabs if tab is not one of the
module’s tabs), the module should use hidden HTML <input> fields to maintain whatever state
information is required when a tab is not visible. Typically, this would involve creating hidden
input fields for each HTML form field which normally appears on an invisible tab. If load_fields
is true, the module should initialize all fields to a default value or current values for the
Affiliate being edited. Note: Error messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Affiliate_Delete" PARAMETERS="module var, affiliate var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs module-specific actions when an Affiliate is deleted. It is called prior to
the Affiliate record being deleted from the database.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Affiliate_Head" PARAMETERS="module var, tab, affiliate var" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.7
This function allows the module to output content in the HTML <head> tag of the Add/Edit Affiliate
screen. It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Affiliate_Insert" PARAMETERS="module var, affiliate var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs module-specific actions when an affiliate is created. It is called after
the Affiliate record has been inserted into the database. Note: Error messages should be reported
via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Affiliate_Tabs" PARAMETERS="module var, affiliate var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a list of tab codes and titles that are provided by the module. If
affiliate:id is 0, the system is requesting tabs for the Add Affiliate screen. Otherwise, tabs are
being requested for the Edit Affiliate screen and the affiliate will contain the record being
edited.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Affiliate_Update" PARAMETERS="module var, affiliate var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function performs module-specific actions when an affiliate is updated. It is called after
the Affiliate record has been updated in the database. Note: Error messages should be reported via
the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Affiliate_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs validation of additional tab content when an affiliate is added or updated.
If the global variable Edit_Affiliate is empty, the validation is being performed for an addition.
Otherwise, Edit_Affiliate will contain the code of the affiliate being updated.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_affilbe </MvCOMMENT>
<MvFUNCTION NAME="Module_Affiliate_BatchEdit_Content" PARAMETERS="module var, tab, load_fields" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.70
This function is called to render the content of an Affiliate Batch Edit screen tab. When the tab
parameter matches one of the tabs drawn by this module, it draws the controls (using HTML) meant
to be visible on the tab. When the tab parameter does not match, the module hides any input values
in HTML hidden <input> tags.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Affiliate_BatchEdit_Delete" PARAMETERS="module var, affiliate var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function performs module-specific actions when affiliates are deleted. This function is
called for each affiliate deleted on the Affiliate Batch Edit screen. Multiple affiliates can be
deleted at once, which will result in multiple calls to this function. This function is called
prior to the Affiliate record being deleted from the database. Note: Error messages should be
reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Affiliate_BatchEdit_Head" PARAMETERS="module var, tab" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Affiliate Batch
Edit screen. It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Affiliate_BatchEdit_Tabs" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
Module_Affiliate_BatchEdit_Tabs This function returns a string that identifies the tabs to be
added to the default list of system generated tabs. The string takes the following form:
<code>:<Description>,<code2>:<Description2> The module may specify as many <code>:<Description>
pairs as it likes by separating them with commas. A new tab will be drawn for each pair. If the
module returns an empty string, no additional tabs are drawn.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Affiliate_BatchEdit_Update" PARAMETERS="module var, affiliate var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.70
This function performs module-specific actions when an affiliate is updated. It is called when an
affiliate is updated using the Edit Here button on the Affiliate Batch Edit screen, after the
Affiliate record has been updated in the database. Note: Error messages should be reported via the
Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Affiliate_BatchEdit_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function performs module-specific validation. It is called to validate input when an
affiliate is edited using the Edit Here button on the Affiliate Batch Edit screen. Note:
Validation errors can be reported via the FieldError function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_category </MvCOMMENT>
<MvFUNCTION NAME="Module_Category_Content" PARAMETERS="module var, tab, load_fields, category var" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
This function renders content for visible tabs or hides state information for invisible tabs. If
category:id is 0, the system is requesting tabs for the Add Category screen. Otherwise, tabs are
being requested for the Edit Category screen and category will contain the record being edited. If
tab is the code of one of the module’s tabs, the module should render whatever HTML content is
required for that specific tab. For all other tabs (or for all tabs if tab is not one of the
module’s tabs), the module should use hidden HTML <input> fields to maintain whatever state
information is required when a tab is not visible. Typically, this would involve creating hidden
input fields for each HTML form field which normally appears on an invisible tab. If load_fields
is true, the module should initialize all fields to a default value or current values for the
category being edited.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Category_Delete" PARAMETERS="module var, category var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function performs module-specific actions when a category is deleted. It is called prior to
the Category record being deleted from the database. Note: Error messages should be reported via
the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Category_Head" PARAMETERS="module var, tab, category var" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Add/Edit Category
screen. It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Category_Insert" PARAMETERS="module var, category var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function performs module-specific actions when a category is created. It is called after the
Category record has been inserted into the database.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Category_Tabs" PARAMETERS="module var, category var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a list of tab codes and titles that are provided by the module. If
category:id is 0, the system is requesting tabs for the Add Category screen. Otherwise, tabs are
being requested for the Edit Category screen and category will contain the record being edited.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Category_Update" PARAMETERS="module var, category var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function performs module-specific actions when a category is updated. It is called after the
Category record has been updated in the database. Note: Error messages should be reported via the
Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Category_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs validation of additional tab content when a category is added or updated.
If the global variable Edit_Category is empty, the validation is performed for an addition.
Otherwise, Edit_Category contains the code of the category being updated. Note: Modules can call
the FieldError function to report invalid input fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_categorybe </MvCOMMENT>
<MvFUNCTION NAME="Module_Category_BatchEdit_Content" PARAMETERS="module var, tab, load_fields" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.70
This function is called to render the content of a Category Batch Edit screen tab. When the tab
parameter matches one of the tabs drawn by this module, it draws the controls (using HTML) meant
to be visible on the tab. When the tab parameter does not match, the module hides any input values
in HTML hidden <input> tags.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Category_BatchEdit_Delete" PARAMETERS="module var, category var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function performs module-specific actions when categories are deleted. It is called for each
category deleted on the Category Batch Edit screen. Multiple categories may be deleted at once,
which will result in multiple calls to this function. This function is called prior to the
Category record being deleted from the database.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Category_BatchEdit_Head" PARAMETERS="module var, tab" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Category Batch
Edit screen. It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Category_BatchEdit_Tabs" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function returns a string that identifies the tabs to be added to the default list of system
generated tabs. The string takes the following form: <code>:<Description>,<code2>:<Description2>
The module may specify as many <code>:<Description> pairs as it likes by separating them with
commas. A new tab will be drawn for each pair. If the module returns an empty string, no
additional tabs are drawn.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.code_text }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Category_BatchEdit_Update" PARAMETERS="module var, category var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.70
This function performs module-specific actions when a category is updated. It is called when a
category is updated using the Edit Here button on the Category Batch Edit screen. This function is
called after the Category record has been updated in the database. Note: Error messages should be
reported via the Error function
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Category_BatchEdit_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function performs module-specific validation. It is called to validate input when a category
is edited using the Edit Here button on the Category Batch Edit screen. Note: Validation errors
can be reported via the FieldError function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_product </MvCOMMENT>
<MvFUNCTION NAME="Module_Product_Content" PARAMETERS="module var, tab, load_fields, product var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function renders content for visible tabs or hides state information for invisible tabs. If
product:id is 0, the system is requesting tabs for the Add Product screen. Otherwise, tabs are
being requested for the Edit Product screen and product will contain the record being edited. If
tab is the code of one of the module’s tabs, the module should render whatever HTML content is
required for that specific tab. For all other tabs (or for all tabs if tab is not one of the
module’s tabs), the module should use hidden HTML <input> fields to maintain whatever state
information is required when a tab is not visible. Typically, this would involve creating hidden
input fields for each HTML form field which normally appears on an invisible tab. If load_fields
is true, the module should initialize all fields to a default value or current values for the
product being edited. Note: Error messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Product_Delete" PARAMETERS="module var, product var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function performs module-specific actions when a product is deleted. It is called prior to
the Product record being deleted from the database.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Product_Head" PARAMETERS="module var, tab, product var" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Add/Edit Product
screen. It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Product_Insert" PARAMETERS="module var, product var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function performs module-specific actions when a product is created. It is called after the
Product record has been inserted into the database. Note: Error messages should be reported via
the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Product_Tabs" PARAMETERS="module var, product var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Returns a list of tab codes and titles that are provided by the module. If product:id is 0, the
system is requesting tabs for the Add Product screen. Otherwise, tabs are being requested for the
Edit Product screen and product will contain the record being edited.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Product_Update" PARAMETERS="module var, product var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function performs module-specific actions when a product is updated. It is called after the
Product record has been updated in the database. Note: Error messages should be reported via the
Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Product_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs validation of additional tab content when a product is added or updated. If
the global variable Edit_Product is empty, the validation is being performed for an addition.
Otherwise, Edit_Product will contain the code of the product being updated. Note: Modules can call
the FieldError function to report invalid input fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_productbe </MvCOMMENT>
<MvFUNCTION NAME="Module_Product_BatchEdit_Content" PARAMETERS="module var, tab, load_fields" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.70
This function is called to render the content of a Product Batch Edit screen tab. When the tab
parameter matches one of the tabs drawn by this module, it draws the controls (using HTML) meant
to be visible on the tab. When the tab parameter does not match, the module hides any input values
in HTML hidden <input> tags.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Product_BatchEdit_Delete" PARAMETERS="module var, product var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function performs module-specific actions when products are deleted. This function is called
for each product deleted on the Product Batch Edit screen. Multiple products may be deleted at
once, which will result in multiple calls to this function. This function is called prior to the
Product record being deleted from the database. Note: Error messages should be reported via the
Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Product_BatchEdit_Head" PARAMETERS="module var, tab" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Product Batch Edit
screen. It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Product_BatchEdit_Tabs" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function returns a string that identifies the tabs to be added to the default list of system
generated tabs. The string takes the following form: <code>:<Description>,<code2>:<Description2>
The module may specify as many <code>:<Description> pairs as it likes by separating them with
commas. A new tab will be drawn for each pair. If the module returns an empty string, no
additional tabs are drawn.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Product_BatchEdit_Update" PARAMETERS="module var, product var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.70
This function performs module-specific actions when a product is updated. It is called when a
product is updated using the Edit Here button on the Product Batch Edit screen. This function is
called after the Product record has been updated in the database. Note: Error messages should be
reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Product_BatchEdit_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function performs module-specific validation. It is called to validate input when a product
is edited using the Edit Here button on the Product Batch Edit screen. Note: Modules can call the
FieldError function to report invalid input fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_cust </MvCOMMENT>
<MvFUNCTION NAME="Module_Customer_Content" PARAMETERS="module var, tab, load_fields, customer var" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
This function renders content for visible tabs or hides state information for invisible tabs. If
customer:id is 0, the system is requesting tabs for the Add Customer screen. Otherwise, tabs are
being requested for the Edit Customer screen and customer will contain the record being edited. If
tab is the code of one of the module’s tabs, the module should render whatever HTML content is
required for that specific tab. For all other tabs (or for all tabs if tab is not one of the
module’s tabs), the module should use hidden HTML <input> fields to maintain whatever state
information is required when a tab is not visible. Typically, this would involve creating hidden
input fields for each HTML form field that normally appears on an invisible tab. If load_fields is
true, the module should initialize all fields to a default value or current values for the
customer being edited. Note: Error messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_Delete" PARAMETERS="module var, customer var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function performs module-specific actions when a customer is deleted from the Administrative
Interface. It is called prior to the Customer record being deleted from the database. Note: Error
messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_Head" PARAMETERS="module var, tab, customer var" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Add/Edit Customer
screen. It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_Insert" PARAMETERS="module var, customer var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function performs module-specific actions when a customer is created in the Administrative
Interface. It is called after the Customer record has been inserted into the database. Note: Error
messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_Tabs" PARAMETERS="module var, customer var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a list of tab codes and titles that are provided by the module. If
customer:id is 0, the system is requesting tabs for the Add Customer screen. Otherwise, tabs are
being requested for the Edit Customer screen and customer will contain the record being edited.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_Update" PARAMETERS="module var, customer var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function performs module-specific actions when a customer is updated in the Administrative
Interface. It is called after the Customer record has been updated in the database. Note: Error
messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs validation of additional tab content when a customer is added or updated
from the Administrative Interface. If the global variable Edit_Customer is empty, the validation
is being performed for an addition. Otherwise, Edit_Customer will contain the code of the customer
being updated. Note: Modules can call the FieldError function to report invalid input fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_custbe </MvCOMMENT>
<MvFUNCTION NAME="Module_Customer_BatchEdit_Content" PARAMETERS="module var, tab, load_fields" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.70
This function is called to render the content of a Customer Batch Edit screen tab. When the tab
parameter matches one of the tabs drawn by this module, it draws the controls (using HTML) meant
to be visible on the tab. When the tab parameter does not match, the module hides any input values
in HTML hidden <input> tags.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_BatchEdit_Delete" PARAMETERS="module var, customer var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function performs module-specific actions when customers are deleted. It is called for each
customer deleted on the Customer Batch Edit screen. Multiple customers may be deleted at once,
which will result in multiple calls to this function. This function is called prior to the
Customer record being deleted from the database. Note: Error messages should be reported via the
Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_BatchEdit_Head" PARAMETERS="module var, tab" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Customer Batch
Edit screen. It is useful for outputting CSS styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_BatchEdit_Tabs" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function returns a string that identifies the tabs to be added to the default list of system
generated tabs. The string takes the following form: <code>:<Description>,<code2>:<Description2>
The module may specify as many <code>:<Description> pairs as it likes by separating them with
commas. A new tab will be drawn for each pair. If the module returns an empty string, no
additional tabs are drawn.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_BatchEdit_Update" PARAMETERS="module var, customer var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.70
This function performs module-specific actions when a customer is updated. It is called when a
customer is updated using the Edit Here button on the Customer Batch Edit screen. This function is
called after the Customer record has been updated in the database. Note: Error messages should be
reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_BatchEdit_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function performs module-specific validation. It is called to validate input when a customer
is edited using the Edit Here button on the Customer Batch Edit screen. Note: Validation errors
can be reported via the FieldError function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> vis_order </MvCOMMENT>
<MvFUNCTION NAME="Module_Order_Content" PARAMETERS="module var, tab, load_fields" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.0
This function renders content for visible tabs or hides state information for invisible tabs. The
global variable Edit_Order will contain the ID of the order being edited. If tab is the code of
one of the module’s tabs, the module should render whatever HTML content is required for that
specific tab. For all other tabs (or for all tabs if tab is not one of the module’s tabs), the
module should use hidden HTML <input> fields to maintain whatever state information is required
when a tab is not visible. Typically, this would involve creating hidden input fields for each
HTML form field which normally appears on an invisible tab. If load_fields is true, the module
should initialize all fields to a default value or current values for the order being edited.
Note: Error messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Order_Delete" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.02 -- Depreciated at 5.51
This function is called prior to the Order record being deleted from the database. It is called
when an order is deleted from the Order Detail screen, the legacy View Order screen, the legacy
Order Batch Edit screen or when a batch of orders is deleted from the legacy Batch screen. To
determine which order is being deleted will require determining which location is calling the
function and then examining the internal state of the Administrative Interface. Note: Because the
order being deleted is not passed to the module as a parameter, the order must be inferred by
examining global variables. Refer to Appendix D: Deleting Orders on page 311 for further details.
Note: This function has been deprecated and should only be used to ensure compatibility with older
versions of Miva Merchant. New modules should also implement Module_Order_Delete_Order. Note:
Error messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Order_Delete_Order" PARAMETERS="module var, order var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.51
This function performs module-specific actions when an Order record is deleted from the database.
It is called when an order is deleted from the Order Detail screen, the legacy View Order screen,
the legacy Order Batch Edit screen or when a batch of orders is deleted from the legacy Batch
screen. Note: Error messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Order_Head" PARAMETERS="module var, tab, order var" STANDARDOUTPUTLEVEL="text,html">
<MvCOMMENT>
API: 5.70
This function allows the module to output content in the HTML <head> tag of the Legacy Order
Processing Edit Order screen and new Order Management tab screens. It is useful for outputting CSS
styles or external JavaScript references.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Order_Tabs" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a list of tab codes and titles that are provided by the module. The global
variable Edit_Order contains the ID of the order being edited.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Order_Update" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function performs module-specific actions when an order is updated. It is called prior to the
Order record being updated in the database. The ID of the order being updated is present in the
global variable Edit_Order. Note: Error messages should be reported via the Error function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Order_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function performs validation of additional tab content when an order is updated. The ID of
the order being updated is present in the global variable Edit_Order. Note: Modules can call the
FieldError function to report invalid input fields.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> cleanup_store </MvCOMMENT>
<MvFUNCTION NAME="Module_Cleanup_Store" PARAMETERS="module var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.7 -- PR8 Update 6
The Module_Cleanup_Store function is called through the admin interface on the Delete Baskets page
when a module contains the feature cleanup_store. This function can do any clean up functionality
your module requires from one unified location in the Miva Merchant admin. It is also available
through provisioning.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> clientside </MvCOMMENT>
<MvFUNCTION NAME="Module_Clientside" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function is called when a clientside.mvc URL contains the Module_Code parameter. The filename
requested is available in g.Filename. The module should call the function Module_Content_Type in
g.Module_Clientside to set the content type, then directly output the appropriate static content.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvCOMMENT> designer </MvCOMMENT>
<MvFUNCTION NAME="DesignerComponentModule_Export" PARAMETERS="module var, page var, output_root_option, output_dir, extfile_dir, item, all_settings var, settings var, param, output_type var, start_data var, end_data var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is called by TemplateManager_Export_Template for modules containing feature
designer. Its purpose is to export the template data from a given module, as HTML text or as a
file, to be edited in an external editor and/or imported later. If using output_type “html”,
you can place data into l.start_data and l.end_data. This data will then be passed back to
TemplateManager_Export_Template and written along with the other data. If using output_type
“file”, you must provide a file name in l.start_data (l.end_data will be ignored in this
case). In order for the linking to work correctly with output_type “file”,
DesignerComponentModule_Export must recursively call function TemplateManager_Export_Template with
the current template source data and the file name you are returning in l.start_data.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="DesignerComponentModule_ImportProvisionLines" PARAMETERS="module var, page_code, name, param, settings" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is called indirectly by TUI_Import_Page to generate provision code that can then be
used by the provision features library to import the data within the files you saved in the
editable directory. Place the edited template/page files you wish to import into a location that
you set up in the store Admin under the Template Import/Export Settings tab. From the Pages screen
in Admin, check the “Import” checkbox next to the page to be updated and click Update. This
function will link the import file location to the actual import code, which then (during the
provision step) looks at that file location, reads the contents of the file, and imports it into
the current page item’s template.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.XML_code }">
</MvFUNCTION>
<MvCOMMENT> report </MvCOMMENT>
<MvFUNCTION NAME="ReportModule_Calculate_DateRange_All" PARAMETERS="module var, report var, time_t_start, time_t_end" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
When the module implements the date_range capability, this function is called when the user has
configured a report with a date range of “All Dates” to determine the earliest and latest date
that will be present in the generated report.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_Capabilities" PARAMETERS="module var, capabilities var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function describes the functionality that the report module provides to the report subsystem.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_Chart_Type" PARAMETERS="module var, report var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function is only required if the module implements the output_chart capability. It is called
to determine the type of chart that the report module will output.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.html or svg_line }">
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_Display" PARAMETERS="module var, report var" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.70
This function is called only when the module implements the display capability and the Report
record in question has been configured to be displayed on the Main page. It is called to output a
Main-page display of the chart data. Typically, this is a summary of the full report data. For
example, the standard report modules in PR8 generate summary displays using sparklines or smaller
displays of a subset of the data. The module may output any HTML that is normally valid in the
administrative interface from this function.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_Export" PARAMETERS="module var, report var" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.70
This function is called to output a custom export format when the module implements the
output_custom capability. The module is responsible for all output (including a starting <HTML>
tag if the output format is HTML) and may control the output content-type or other response
headers using miva_output_header.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_Field" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.70
This function is called to render the HTML input elements for a single configuration field from
the list returned by ReportModule_Fields.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_Fields" PARAMETERS="module var, report var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
Returns a comma separated list of identifiers, one for each configuration field that should be
displayed when adding or editing a report that uses this module.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.CSV_fieldlist }">
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_Format_Vertical_Label" PARAMETERS="module var, report var, set_id, data" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function is presently only required if the module implements the output_chart feature and
specifies a chart type of “svg_line” as the return value from ReportModule_Chart_Type. It may
also be required for new chart types in the future. This function adds whatever formatting is
required for proper display of a vertical label in the output chart. For example, it could format
dollar amounts using the store’s currency formatting module, or add commas to non-currency
numeric values. Note: For SVG line charts, HTML is permitted, however future chart types may not
properly handle HTML.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.formatted_value }">
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_HTML_Chart" PARAMETERS="module var, report var" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.70
When ReportModule_Chart_Type returns “html”, this function is called to allow the module to
output whatever content is required to visualize or chart the report data. The module is
responsible for all output.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_Invalid" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
When ReportModule_Validate returns 0, this function is called for each field_id from the list
returned by ReportModule_Fields to determine if the field’s prompt should be shown in the
invalid state.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_Prompt" PARAMETERS="module var, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function is called for each field in the list returned by ReportModule_Fields to get a prompt
that is displayed to the user.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.text_prompt }">
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_Provision_Settings" PARAMETERS="module var, report var, provide_xml var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function is called only if the module implements the provision_settings capability. This
function is called when a report is being added using the <Report_Add> provisioning tag to
provision module-specific configuration values for the report. If the module returns 0, the
provisioned report is not added Note: Modules should report provisioning errors/warnings with
PRV_LogMessage or PRV_LogError
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_Run" PARAMETERS="module var, report var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function is called to execute the report when the module does not implement the date_range
capability. When called, the module should do whatever operations are required to gather data for
the report. Generally, this will involve making database queries and storing records in the
ReportData table.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_Run_DateRange" PARAMETERS="module var, report var, time_t_start, time_t_end" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function is called when the module implements the date_range capability and does not
implement the date_interval capability. When called, the module should execute whatever queries
are required to generate the report data and store the data in the ReportData table or in a
modulespecific format. Important: The ending time_t is not inclusive and the report should include
data that is < time_t_end, not <= time_t_end.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_Run_Intervals" PARAMETERS="module var, report var, time_t_start, time_t_end, intervals var, interval_count" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function is called to run a report when the module implements both the date_range and
date_interval capabilities. Important: The ending time_t is not inclusive and the report should
include data that is < time_t_end, not <= time_t_end.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_SVG_Line_Chart_Definition" PARAMETERS="module var, report var, chart var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
When the module implements the output_chart capability, and ReportModule_Chart_Type returns
“svg_line”, this function is called by the report subsystem to determine what data sets should
be included in the SVG line chart and other controls over the chart display.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_Tabular_Definition" PARAMETERS="module var, report var, definition var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function is called when a report using a module that implements the output_tabular capability
is exported in either CSV or XLS format. The function fills out the definition parameter to define
the rows and columns that are then exported into the requested tabular format by the report
subsystem.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_Update" PARAMETERS="module var, report var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.70
This function is called to store the configuration of a report when the report is added or updated
in the administrative interface.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ReportModule_Validate" PARAMETERS="module var, report var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70
This function is called to validate the HTML input controls for the fields defined by
ReportModule_Fields when a report is being added or updated.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> storewizard </MvCOMMENT>
<MvFUNCTION NAME="StoreWizardModule_Action" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function after the user completes all steps in the wizard and after a
successful return from StoreWizardModule_Privileges and StoreWizardModule_Validate. It can be used
to deliver instructions about what to do with or in reaction to the input submitted by the user.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="StoreWizardModule_Content" PARAMETERS="module var, step, load_fields" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function each time the wizard displays a new screen. It provides the
instructions for the main portion of the wizard screen.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="StoreWizardModule_Icon" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0 -- depreciated in PR5
This function is used to define the path and name of the icon graphic that is displayed on the
admin.mv front page under the store section. Note: Icons have not been used in wizard modules
since PR5.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="StoreWizardModule_Logo" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is used to define the path and name of the logo graphic that is displayed in the
upper left corner of the wizard. It is called each time the wizard displays a new screen.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.image_path }">
</MvFUNCTION>
<MvFUNCTION NAME="StoreWizardModule_Privileges" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when the Admin expands the store portion of its left menu.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="StoreWizardModule_Title" PARAMETERS="module var, step" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function each time the Admin displays a new wizard screen.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.title }">
</MvFUNCTION>
<MvFUNCTION NAME="StoreWizardModule_Validate" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function after the user completes all the steps in the wizard.
Instructions should be included in the function on an acceptable format for information the
Administrator submits.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="StoreWizardModule_Validate_Step" PARAMETERS="module var, step" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function each time the Admin receives input from the submission of a
wizard screen (one screen per step). In case of failure, the Admin will not allow the wizard to
move onto the next screen. Instructions should be included in the function on an acceptable format
for information the Administrator submits. Flags can be set for use by the UI to indicate an
invalid state.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> skins </MvCOMMENT>
<MvFUNCTION NAME="SkinsComponentModule_Description" PARAMETERS="module var, item var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a textual description of the component module’s functionality for a single
item. In the current software, this text is displayed as a tooltip when hovering over the Help
link next to a framework component when saving a framework.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="SkinsComponentModule_Export" PARAMETERS="module var, output var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0 -- Depreciated by 5.60
This function is called when saving a framework to allow the module to export the settings for all
items and pages that reference the component. The output should be in Miva Merchant XML
provisioning format and be placed into the output parameter. Note: This function has been
deprecated and should only be used to ensure compatibility with older versions of Miva Merchant.
New modules should implement SkinsComponentModule_Export_Item.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="SkinsComponentModule_Export_Item" PARAMETERS="module var, item var, output var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.60
When saving a framework, the system calls this function once for each item registered to a
component. When called, the module should output the XML provisioning code required to replicate
the settings for the specified item on every page to which it is assigned. Typically, a module
would loop through the list of pages to which the item is assigned, exporting the settings for
each page separately. Note: The provisioning code should be appended to the output parameter.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvCOMMENT> shipping_label </MvCOMMENT>
<MvFUNCTION NAME="ShippingModule_Label_Boxes" PARAMETERS="module var, ordershipment var, boxes var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function allows a module to return a list of shipper-specific boxes that may be used when
generating labels. These boxes are displayed alongside the boxes configured by the merchant in the
label generation dialog. Examples of shipper-specific boxes: • USPS® Large Flat Rate Box •
FedEx® Express Envelope
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.box_count }">
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Field" PARAMETERS="module var, method, field_id" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.60 -- Deprecated after PR8 Upda
This function draws a single input field for label generation. HTML is allowed. Note: This
function has been deprecated and should only be used to ensure compatibility with older versions
of Miva Merchant. New modules should also implement ShippingModule_Label_Shipment_Field. Note: In
Miva Merchant PR7 through PR8 Update 3, there is a single package per shipment. Only a single set
of the fields returned by ShippingModule_Label_Fields and drawn by the other
ShippingModule_Label_XXX fields will be displayed at once. In PR8 Update 4 and newer, the fields
defined by these deprecated functions will be drawn once per package within a shipment. The module
will be called multiple times to generate multiple labels for the shipment when there is more than
one package.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Fields" PARAMETERS="module var, method" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.60 -- Deprecated after PR8 Upda
This function returns a comma separated list of field identifiers that will be displayed for the
label. Note: This function has been deprecated and should only be used to ensure compatibility
with older versions of Miva Merchant. New modules should also implement
ShippingModule_Label_Shipment_Fields. Note: In Miva Merchant PR7 through PR8 Update 3, there is a
single package per shipment. Only a single set of the fields returned by
ShippingModule_Label_Fields and drawn by the other ShippingModule_Label_XXX fields will be
displayed at once. In PR8 Update 4 and newer, the fields defined by these deprecated functions
will be drawn once per package within a shipment. The module will be called multiple times to
generate multiple labels for the shipment when there is more than one package.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.CSV_fieldlist }">
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Generate" PARAMETERS="module var, method, source_address var, dest_address var, weight, ordershipment var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.60 -- Deprecated after PR8 Upda
This function is called to generate a single shipping label. If a shipment contains multiple
packages in PR8 Update 4 or newer, this function will be called once per package. Note: This
function has been deprecated and should only be used to ensure compatibility with older versions
of Miva Merchant. New modules should also implement ShippingModule_Labels_Generate. Note: In Miva
Merchant PR7 through PR8 Update 3, there is a single package per shipment. Only a single set of
the fields returned by ShippingModule_Label_Fields and drawn by the other ShippingModule_Label_XXX
fields will be displayed at once. In PR8 Update 4 and newer, the fields defined by these
deprecated functions will be drawn once per package within a shipment. The module will be called
multiple times to generate multiple labels for the shipment when there is more than one package.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Invalid" PARAMETERS="module var, method, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.60 -- Deprecated after PR8 Upda
If ShippingModule_Label_Validate returns 0, ShippingModule_Label_Invalid is called for each field
identifier to determine if a particular field failed validation. If ShippingModule_Label_Invalid
returns 1 for a particular field, that field’s prompt is displayed in red in the user interface.
Note: This function has been deprecated and should only be used to ensure compatibility with older
versions of Miva Merchant. New modules should also implement
ShippingModule_Label_Shipment_Invalid. Note: In Miva Merchant PR7 through PR8 Update 3, there is a
single package per shipment. Only a single set of the fields returned by
ShippingModule_Label_Fields and drawn by the other ShippingModule_Label_XXX fields will be
displayed at once. In PR8 Update 4 and newer, the fields defined by these deprecated functions
will be drawn once per package within a shipment. The module will be called multiple times to
generate multiple labels for the shipment when there is more than one package.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Methods" PARAMETERS="module var, methods var, ordershipment var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.60 -- Update in PR8 Update 4 5.
This function returns a list of shipping methods that the module supports for label generation.
Important: If the API version is 5.71 or higher, the implementation of the function must include
the ordershipment parameter. If the API version is 5.70 or lower, the implementation of the
function must not include the ordershipment parameter.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.method_count }">
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Package_Field" PARAMETERS="module var, method_code, field_id, field_prefix, fields var, product_ids var, product_count" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function draws a single package-level input field.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Package_Fields" PARAMETERS="module var, method_code, field_prefix, fields var, ordershipment var, product_ids var, product_count" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function returns a comma separated list of field identifiers that will be displayed for each
package.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.CSV_fieldlist }">
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Package_Invalid" PARAMETERS="module var, method_code, field_id, field_prefix, fields var, product_ids var, product_count" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function indicates whether a package-level field failed validation and should be displayed in
the invalid state.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Package_Prompt" PARAMETERS="module var, method_code, field_id, field_prefix, fields var, product_ids var, product_count" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function returns the prompt (descriptive text displayed to the left of a field) for the field
identified by field_id.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.text_prompt. }">
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Package_Validate" PARAMETERS="module var, method_code, field_prefix, fields var, product_ids var, product_count" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- Deprecated 5.72 PR8.5
This function is called for each package for which labels will be generated. It allows the module
to validate that the input fields were filled out correctly. Note: This function was replaced with
ShippingModule_Label_Package_Validate_Package in 5.72 API modules. Note: Modules may report
validation errors either through ShippingModule_Label_Package_Invalid or by calling the FieldError
function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Package_Validate_Package" PARAMETERS="module var, method_code, ordershipment var, package var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.72 -- PR8 Update 5
This function is called for each package for which labels will be generated. It allows the module
to validate that the input fields were filled out correctly. Note: For 5.72 API modules, this
function replaces ShippingModule_Label_Package_Validate.
ShippingModule_Label_Package_Validate_Package is functionally identical to
ShippingModule_Label_Package_Validate but the ordershipment record and the entire package record
are passed in to provide the module access to additional fields that may be required for
validation. Note: Modules may report validation errors either through
ShippingModule_Label_Package_Invalid or by calling the FieldError function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Prompt" PARAMETERS="module var, method, field_id" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.70 -- Deprecated by 5.71
This function returns the prompt for a single label generation field. Note: This function has been
deprecated and should only be used to ensure compatibility with older versions of Miva Merchant.
New modules should also implement ShippingModule_Label_Shipment_Prompt. Note: In Miva Merchant PR7
through PR8 Update 3, there is a single package per shipment. Only a single set of the fields
returned by ShippingModule_Label_Fields and drawn by the other ShippingModule_Label_XXX fields
will be displayed at once. In PR8 Update 4 and newer, the fields defined by these deprecated
functions will be drawn once per package within a shipment. The module will be called multiple
times to generate multiple labels for the shipment when there is more than one package.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.prompt }">
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Render" PARAMETERS="module var, label var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
If an OrderShipmentLabel record is created with a “label_type” of “module”, this function
will be called (in the module identified by the OrderShipmentLabel’s module_id field) to draw
the shipping label. This allows a module to handle complex or compound label displays that cannot
be displayed simply by setting the Content-Type header. For example, the UPS Ready® Tools module
labels consist of two parts—HTML and GIF—and the module uses this mechanism to enable the
display of both parts.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Shipment_Field" PARAMETERS="module var, method_code, field_id, ordershipment var" STANDARDOUTPUTLEVEL="text,html,compresswhitespace">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
The ShippingModule_Label_Shipment_XXX functions in API version 5.71 or higher replace the
ShippingModule_Label_XXX functions (ShippingModule_Label_Field, ShippingModule_Label_Fields,
ShippingModule_Label_Generate, ShippingModule_Label_Invalid, ShippingModule_Label_Prompt,
ShippingModule_Label_Validate) from older API versions and allow the module to control fields that
are displayed at the shipment level when generating labels. This function outputs the HTML
required to draw a single shipment-level field.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Shipment_Fields" PARAMETERS="module var, method_code, ordershipment va" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function returns a list of shipment-level field identifiers. Return Value: A comma separated
list of field identifiers. The list is split into individual components and the individual values
are passed as the field_id parameter to the other ShippingModule_Label_Shipment_XXX functions
(ShippingModule_Label_Shipment_Field, ShippingModule_Label_Shipment_Fields,
ShippingModule_Label_Shipment_Invalid, ShippingModule_Label_Shipment_Prompt,
ShippingModule_Label_Shipment_Validate).
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.CSV_fieldlist }">
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Shipment_Invalid" PARAMETERS="module var, method_code, field_id, ordershipment var )" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function is called when ShippingModule_Label_Shipment_Validate returns 0 for each
shipment-level field to determine whether the field’s prompt should be displayed in the invalid
state.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Shipment_Prompt" PARAMETERS="module var, method_code, field_id, ordershipment var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function returns the prompt for a single shipment-level input field.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.prompt }">
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Shipment_Validate" PARAMETERS="module var, method_code, ordershipment var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71 -- PR8 Update 4
This function is called to validate the module’s shipment-level fields. Separate calls to
ShippingModule_Label_Package_Validate are made for each package in the shipment to validate the
packages. Note: Modules may report invalid fields through ShippingModule_Label_Shipment_Invalid or
by calling the FieldError function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Validate" PARAMETERS="module var, method" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.7
This function is called to validate the user’s input prior to generating a label. Note: This
function has been deprecated and should only be used to ensure compatibility with older versions
of Miva Merchant. New modules should also implement ShippingModule_Label_Shipment_Validate. Note:
In Miva Merchant PR7 through PR8 Update 3, there is a single package per shipment. Only a single
set of the fields returned by ShippingModule_Label_Fields and drawn by the other
ShippingModule_Label_XXX fields will be displayed at once. In PR8 Update 4 and newer, the fields
defined by these deprecated functions will be drawn once per package within a shipment. The module
will be called multiple times to generate multiple labels for the shipment when there is more than
one package.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Label_Void_Shipment" PARAMETERS="module var, ordershipment var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.6 -- Depreciated by 5.72
This function facilitates the voiding of shipping labels. When called, the module should perform
whatever actions are required to invalidate all labels generated for the specified shipment. It is
the module’s responsibility to delete any OrderShipmentLabel records that have been voided —
if the void of one or more labels fails, the module should delete the voided labels and leave the
unvoided labels alone. Note: If a module has an API version lower than 5.72, the VOID
functionality is automatically disabled in the user interface when dealing with labels from that
module.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="ShippingModule_Labels_Generate" PARAMETERS="module var, method_code, source_address var, dest_address var, ordershipment var, package_list var, package_count va" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.71
This function replaces ShippingModule_Label_Generate and is called to generate one or more
shipping labels for an OrderShipment record. When called, the module should make whatever API
calls are required to generate the label(s). The module is responsible for inserting one or more
OrderShipmentLabel records containing the label data.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> externalreq </MvCOMMENT>
<MvFUNCTION NAME="Module_External_Requirements_Met" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
The administrative UI calls this function when displaying one of the feature configuration
screens, such as: • System Extension Configuration • Shipping Configuration • Payment
Configuration • Order Fulfillment Configuration • Logging Configuration • System Extension
Configuration • Utilities Configuration If the function does not return TRUE, the Admin will not
include the module in the list of those assignable to the store. The module can be coded to test
for the state of some arbitrary requirement — for example, that the server runs SSL — then
return FALSE if the server fails the test. This would prevent store administrators from installing
the module to the store until and unless the SSL requirement is met.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> fields_cat </MvCOMMENT>
<MvFUNCTION NAME="Module_Category_Field_Name" PARAMETERS="module var, code" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns the name of a Custom Category Field given its code.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Category_Field_Value" PARAMETERS="module var, cat_id, code" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns the string data of a Custom Category Field given its code and the category
item’s ID.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.custom field data }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Category_Fields" PARAMETERS="module var, fields var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns the Custom Category Fields array with the member’s code and name to be
used by the other functions in the Custom Category Fields API.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.element_count }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Category_Set_Field" PARAMETERS="module var, cat_id, code, value" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function sets the new or updated value of the passed category’s custom field.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> fields_cat_map </MvCOMMENT>
<MvFUNCTION NAME="Module_Category_Fields_Mapped" PARAMETERS="module var, cat_id, field_map var, output_fields var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.72 -- PR8 Update 5
This function allows multiple custom fields to be retrieved in a single call to the module. This
improves performance when there are large numbers of custom fields in use. The module should load
the custom fields for the specified category and place the values into output_fields using the
member names specified by field_map.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvCOMMENT> fields_cust </MvCOMMENT>
<MvFUNCTION NAME="Module_Customer_Field_Name" PARAMETERS="module var, code" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns the name of a Custom Customer Field given its code.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.field name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_Field_Value" PARAMETERS="module var, cust_id, code" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns the string data of a Custom Customer Field given its code and the customer
item’s ID.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.custom field data }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_Fields" PARAMETERS="module var, fields var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Administrative Interface. Its purpose is to load the l.fields structure with the name and code for
each custom field that the module supplies. The Customer Export module also calls this function.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.element_count }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Customer_Set_Field" PARAMETERS="module var, cust_id, code, value" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function from the Administrative Interface to update the value of a
custom Customer field via the value parameter.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> fields_prod </MvCOMMENT>
<MvFUNCTION NAME="Module_Product_Field_Name" PARAMETERS="module var, code" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
The UI calls this function when displaying a Custom Product Field on the Product screen (PROD) or
Product List screen (PLIST). It returns a string for display as a field name for the field
corresponding to l.code.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.field name }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Product_Field_Value" PARAMETERS="module var, prod_id, code" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
The Admin calls this function to display the value of a custom field on the Product Configuration
screen. The UI calls this function when displaying a custom product field on the Product page. It
returns a string for display as a field value for the field corresponding to l.code.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.custom field data }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Product_Fields" PARAMETERS="module var, fields var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function when displaying the Product configuration screen and the Edit
Page: Product Display configuration screen in the Administrative Interface. The Product Import and
Export modules also calls this function. Its purpose is to load the l.fields structure with the
name and code for each custom field that the module supplies. When viewing the point and click
administration of the Product Display Layout, the field(s) created by the module will be available
to select for display.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.element_count }">
</MvFUNCTION>
<MvFUNCTION NAME="Module_Product_Set_Field" PARAMETERS="module var, prod_id, code, value" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin relies on this function to instruct it how to update the value (from the value parameter) of
a custom product field (identified by the code parameter) for a given product (identified by the
prod_id parameter). The value comes from manual input from an administrator, an import etc.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> fields_prod_map </MvCOMMENT>
<MvFUNCTION NAME="Module_Product_Fields_Mapped" PARAMETERS="module var, product_id, field_map var, output_fields var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.72 -- PR8 Update 5
This function allows multiple custom fields to be retrieved in a single call to the module. This
improves performance when there are large numbers of custom fields in use. The module should load
the custom fields for the specified product and place the values into output_fields using the
member names specified by field_map.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvCOMMENT> not_cat </MvCOMMENT>
<MvFUNCTION NAME="Module_Notify_Category_Delete" PARAMETERS="module var, category var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function notifies the module that a category has been deleted. When the database layer
updates the status of the category, it calls this function to notify modules that have implemented
the not_cat feature.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Notify_Category_Insert" PARAMETERS="module var, category var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.0
This function notifies the module that a category has been added. When the database layer updates
the status of the category, it calls this function to notify modules that have implemented the
not_cat feature.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Notify_Category_Update" PARAMETERS="module var, category var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 9.03 -- Miva Merchant v9.0003
This function notifies the module that a category has been updated. When the database layer
updates the status of the category, it calls this function to notify modules that have implemented
the not_cat feature.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> not_cust </MvCOMMENT>
<MvFUNCTION NAME="Module_Notify_Customer_Delete" PARAMETERS="module var, customer var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.6 -- PR8 and higher
This function notifies the module that a customer has been deleted. When the database layer
updates the status of the customer, it calls this function to notify modules that have implemented
the not_cust feature.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Notify_Customer_Insert" PARAMETERS="module var, customer var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.6 -- PR8 and higher
This function notifies the module that a customer has been added. When the database layer updates
the status of the customer, it calls this function to notify modules that have implemented the
not_cust feature.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Notify_Customer_Update" PARAMETERS="module var, customer var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 9.03 -- Miva Merchant v9.0003
This function notifies the module that a customer has been updated. When the database layer
updates the status of the customer, it calls this function to notify modules that have implemented
the not_cust feature.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvCOMMENT> not_fields </MvCOMMENT>
<MvFUNCTION NAME="Module_Notify_StandardFields" PARAMETERS="" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0 -- module var, standardfield
This function is called when a user changes the settings on the Customer Fields tab of the Edit
Store screen or when the same settings are changed via provisioning. These settings control which
customer fields are required, which customer fields are optional, whether the “ship to” or the
“bill to” address is the primary address, etc.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvCOMMENT> not_giftcert </MvCOMMENT>
<MvFUNCTION NAME="Module_Notify_GiftCertificate_Created" PARAMETERS="module var, giftcert var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 9.03 -- Miva Merchant v9.0003
This function notifies the module that a gift certificate has been added. When the database layer
inserts a gift certificate, it calls this function to notify modules that have implemented the
not_giftcert feature.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Notify_GiftCertificate_Deleted" PARAMETERS="module var, giftcert var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 9.03 -- Miva Merchant v9.0003
This function notifies the module that a gift certificate has been deleted. When the database
layer deletes a gift certificate, it calls this function to notify modules that have implemented
the not_giftcert feature.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Notify_GiftCertificate_Redeemed" PARAMETERS="module var, customer var, giftcert var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 9.03 -- Miva Merchant v9.0003
This function notifies the module that a gift certificate has been redeemed. When the runtime
layer redeems a gift certificate, it calls this function to notify modules that have implemented
the not_giftcert feature.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Notify_GiftCertificate_Updated" PARAMETERS="module var, giftcert var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 9.03 -- Miva Merchant v9.0003
This function notifies the module that a gift certificate has been updated. When the database
layer updates a gift certificate, it calls this function to notify modules that have implemented
the not_giftcert feature.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvCOMMENT> not_image </MvCOMMENT>
<MvFUNCTION NAME="Module_Notify_Image_Delete" PARAMETERS="module var, image var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 9.03 -- Miva Merchant v9.0003
This function notifies the module that an image has been deleted. When the database layer deletes
an image, it calls this function to notify modules that have implemented the not_image feature.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Notify_Image_Insert" PARAMETERS="module var, image var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 9.03 -- Miva Merchant v9.0003
This function notifies the module that an image has been inserted. When the database layer inserts
an image, it calls this function to notify modules that have implemented the not_image feature.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvCOMMENT> not_order </MvCOMMENT>
<MvFUNCTION NAME="Module_Notify_Order_BatchChange" PARAMETERS="module var, order_count, original_orders var, orders var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 9.00 -- Miva Merchant v9.0000
This function notifies the module that one or more Order records have changed. When the database
layer updates the batch ID of one or more orders, it calls this function to notify modules that
have implemented the not_order feature. Multiple order records updated in a single operation (such
as when all unbatched orders are batched) cause a single notification with all of the orders
passed in a group.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Notify_Order_StatusChange" PARAMETERS="module var, original_status, order var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 9.00 -- Miva Merchant v9.0000
This function notifies the module that the status of an order record has changed. When the
database layer updates the status of an order, it calls this function to notify modules that have
implemented the not_order feature.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvCOMMENT> not_orderitem </MvCOMMENT>
<MvFUNCTION NAME="Module_Notify_OrderItem_Delete" PARAMETERS="module var, count, original_orderitems var, orderitems var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.73 -- PR8 Update 7
This function is called by Miva Merchant when an OrderItem record is deleted. As with
Module_Notify_OrderItem_StatusChange, Miva Merchant only calls the function once, passing the list
of order items deleted.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Notify_OrderItem_StatusChange" PARAMETERS="module var, orderitem_count, original_orderitems var, orderitems var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.73 -- PR8 Update 7
This function notifies the module that one or more OrderItem records have changed. When the
database layer updates the status of one or more OrderItems, it calls this function to notify
modules that have implemented the not_orderitem feature. Multiple OrderItem records updated in a
single operation (such as when the status of an OrderShipment record changes) cause a single
notification with all of the OrderItems passed in a group.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvCOMMENT> not_orderreturn </MvCOMMENT>
<MvFUNCTION NAME="Module_Notify_OrderReturn_StatusChange" PARAMETERS="module var, orderreturn_count, original_orderreturns var, orderreturns var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function notifies the module that one or more OrderReturn records have changed. When the
database layer updates the status of one or more OrderReturns, it calls this function to notify
modules that have implemented the not_orderreturn feature. Multiple OrderReturn records updated in
a single operation are grouped into batches by their associated Order ID, resulting in a single
notification for each unique Order.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvCOMMENT> not_ordershpmnt </MvCOMMENT>
<MvFUNCTION NAME="Module_Notify_OrderShipment_StatusChange" PARAMETERS="module var, orderreturn_count, original_orderreturns var, orderreturns var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0 -- module var, ordershipment
This function notifies the module that one or more OrderShipment records have changed. When the
database layer updates the status of one or more OrderShipments, it calls this function to notify
modules that have implemented the not_ordershpmnt feature. Multiple OrderShipment records updated
in a single operation are grouped into batches by their associated Order ID, resulting in a single
notification for each unique Order. Notifications are sent whenever the numeric state of a
shipment changes or when the tracking information or label information changes.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvCOMMENT> not_prod </MvCOMMENT>
<MvFUNCTION NAME="Module_Notify_Product_Delete" PARAMETERS="module var, product var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.7 -- PR8 and higher
This function notifies the module that a product has been deleted. When the database layer updates
the status of the product, it calls this function to notify modules that have implemented the
not_prod feature.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Notify_Product_Insert" PARAMETERS="module var, product var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 5.7 -- PR8 and higher
This function notifies the module that a product has been added. When the database layer updates
the status of the product, it calls this function to notify modules that have implemented the
not_prod feature.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="Module_Notify_Product_Update" PARAMETERS="module var, product var" STANDARDOUTPUTLEVEL="" ERROROUTPUTLEVEL = "">
<MvCOMMENT>
API: 9.03 -- Miva Merchant v9.0003
This function notifies the module that a product has been updated. When the database layer updates
the status of the product, it calls this function to notify modules that have implemented the
not_prod feature.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvCOMMENT> not_seo </MvCOMMENT>
<MvFUNCTION NAME="Module_Notify_SEOSettings" PARAMETERS="module var, seo_settings var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
When the domain-level SEO settings are modified, this function is called for all not_seo modules
in each configured store, allowing modules to perform any actions that are dependent on the SEO
settings. For example, the MMUI and CSSUI modules use this feature to create or destroy the SEO
Sitemap page when the domain-level sitemap feature is toggled on or off. Note: This function is
called after the SEO settings have been updated.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvCOMMENT> storeui </MvCOMMENT>
<MvFUNCTION NAME="StoreUIModule_Create_Frameworks" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.6
When a new store is created, this function is called in the UI module that the user selected for
the new store so the module can register any default frameworks that should be present in a newly
created store. Frameworks are registered by calling the Skin_Directory_Verify and
SKIN_Sample_Retrieve functions in features/tui/tui_ut.mv.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="StoreUIModule_Create_Items" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
When a new store is being created, this function is called to allow the selected UI module to
create the default list of items for the new store. Items are typically registered by calling the
TemplateManager_Create_Item function in features/tui/tui_mgr.mv. This function is called before
StoreUIModule_Create_Pages so that the items will be registered with the template manager before
the default set of pages is created.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="StoreUIModule_Create_Pages" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
When a new store is being created, this function is called to allow the selected UI module to
create the default set of pages for the new store. The pages are created by calling the
TemplateManager_Create_Page function in features/tui/tui_mgr.mv. UI Modules should pass their own
module ID as the ui_id parameter to that function, which will prevent the user from deleting the
page manually.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="StoreUIModule_Dispatch" PARAMETERS="module var, page var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is called prior to rendering a page to allow the UI module to intercept the page
render request. For example, MMUI and CSSUI use this function to turn the dynamic page code ACNT
into either ACED or ACAD depending on whether a shopper is logged into their customer account.
Other uses include preventing display of certain pages unless certain criteria are met (such as
minimum order requirements) or performing session verification to make sure that a secondary
access token is present before displaying sensitive information Return Value: 1 if the page render
should proceed as normal 0 if the module wants to prevent the default page render -1 on error
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="StoreUIModule_Exception" PARAMETERS="module var, code" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is called when a UI exception occurs. UI exceptions can occur during input
validation prior to an action, or by a component module using the TemplateManager_Throw_Exception
function. This allows the UI module to take whatever action is required to handle the exception,
for example, setting an error message and/or redirecting the user to an error page.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="StoreUIModule_Thumbnail" PARAMETERS="module var" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0 -- Depreciated
This function returns a URI or URL to a graphic that contains a thumbnail example of what the UI
module’s shopping interface looks like. Note: This function is not called in the current version
of the software. Return Value A URI relative to the base URL for graphics or URL. The MMUI
thumbnail is 200x150 pixels.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ l.uri }">
</MvFUNCTION>
<MvCOMMENT> storeselui </MvCOMMENT>
<MvFUNCTION NAME="UIModule_StoreSelection_Content" PARAMETERS="tab, load_fields" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Miva Merchant calls this function from the selected storeselui module when the Admin displays the
Domain Settings screen.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="UIModule_StoreSelection_Render" PARAMETERS="" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is called to render a store selection UI when there is more than one store in the
domain and the parameters for a page hit do not indicate a specific store.
</MvCOMMENT>
<MvFUNCTIONRETURN>
</MvFUNCTION>
<MvFUNCTION NAME="UIModule_StoreSelection_Tabs" PARAMETERS="" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
Admin calls this function when displaying the Domain Settings screen. It returns a tab list using
the following format: <code>:<Description>,<code2>:<Description2> Codes must be unique across
modules. Miva Merchant recommends that the codes include the module code. The module may specify
as many <code>:<Description> pairs as it likes by separating them with commas. A new tab will be
drawn for each pair. If the module returns an empty string, no additional tabs are drawn.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE="{ toupper(l.module:code) $ ':' $ l.module:name }">
</MvFUNCTION>
<MvFUNCTION NAME="UIModule_StoreSelection_Thumbnail" PARAMETERS="" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function returns a URI or URL to a graphic that contains a thumbnail example of what the
store selection layout looks like. Note: This function is not called in the current version of the
software as alternate store selection layout has been disabled since PR5. A URI relative to the
base URL for graphics or URL. The default store selection layout thumbnail is 200x150 pixels
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="UIModule_StoreSelection_Update" PARAMETERS="" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is called when the user presses the Update button to update the fields on the tab(s)
drawn by UIModule_StoreSelection_Content.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
<MvFUNCTION NAME="UIModule_StoreSelection_Validate" PARAMETERS="" STANDARDOUTPUTLEVEL="">
<MvCOMMENT>
API: 5.0
This function is called to validate the fields on the tab(s) drawn by
UIModule_StoreSelection_Content, prior to calling UIModule_StoreSelection_Update.
</MvCOMMENT>
<MvFUNCTIONRETURN VALUE = 1>
</MvFUNCTION>
以上是关于xml Miva - 一个模块中所有功能的示例的主要内容，如果未能解决你的问题，请参考以下文章
xml 示例Miva SearchSpring IntelliSuggest