Dev:Gateway:Config - Revision history

SarahK at 16:50, 17 December 2021

2021-12-17T16:50:04Z

Matt at 09:57, 13 May 2014

2014-05-13T09:57:35Z

Matt at 08:48, 13 May 2014

2014-05-13T08:48:56Z

Matt at 12:23, 10 May 2014

2014-05-10T12:23:48Z

Matt at 12:13, 10 May 2014

2014-05-10T12:13:19Z

Matt: moved Dev:Gateway:Config Function to Dev:Gateway:Config

2014-05-10T12:10:41Z

moved Dev:Gateway:Config Function to Dev:Gateway:Config

Matt: Created page with '
Required Function
The config function is a required function for every gateway module where you must define the …'

2014-05-10T12:04:38Z

Created page with '<div class="docs-alert-warning"> <span class="title">Required Function</span><br /> The config function is a required function for every gateway module where you must define the …'

New page

<div class="docs-alert-warning">
<span class="title">Required Function</span><br />
The config function is a required function for every gateway module where you must define the display name of your module, and any settings a user must configure for it.
</div>

There are 2 required system attributes - a Friendly Name - this is the name that is displayed to users of your module within the WHMCS interface, and the Usage Notes which allow you to provide additional instructions to users of your module.

Following those you can define an unlimited number of settings your module requires. These take the format below:

<source lang="php">
"settingname" => array(
"FriendlyName" => "Display Name",
"Type" => "xxxx",
// Additional attributes here
),
</source>

We'll look at all the possible setting field types and their supported attributes below. But first, let's take a look at an example of a typical configuration function for a gateway module.

<source lang="php">
function demogateway_config() {
return array(
"FriendlyName" => array(
"Type" => "System",
"Value" => "My Custom Gateway Module",
),
"accountnumber" => array(
"FriendlyName" => "Account Number",
"Type" => "text",
"Size" => "10",
"Description" => "<a href=\"#\">Click here to Signup</a>"
),
"apiusername" => array(
"FriendlyName" => "API Username",
"Type" => "text",
"Size" => "20",
),
"apipassword" => array(
"FriendlyName" => "API Password",
"Type" => "password",
"Size" => "20",
),
"testmode" => array(
"FriendlyName" => "Test Mode",
"Type" => "yesno",
"Default" => false,
"Description" => "Tick to enable",
),
);
}
</source>

The settings you define here will be passed into all the functions of your gateway module any time it is called. Please Note: we recommend avoiding generic names like "invoiceid" and "currency" which may conflict with other data WHMCS is passing to your gateway's functions.

← Older revision		Revision as of 12:23, 10 May 2014
Line 1:		Line 1:
		+	<div class="docs-alert-warning">
	'''This is a required function'''		'''This is a required function'''
		+	</div>

	This is where you define the display name for your module, setup/usage instructions (if applicable) and any settings a user must configure for it.		This is where you define the display name for your module, setup/usage instructions (if applicable) and any settings a user must configure for it.

@@ Line 80: / Line 80: @@
              "Type" => "yesno",
              "Default" => false,
-             "Description" => "Tick to enable",
+             "Description" => "Check to enable",
          ),
      );
+}
 </source>

@@ Line 1: / Line 1: @@
-<div class="docs-alert-warning">
+<div class="docs-alert-danger">
 <span class="title">Required</span><br />
 This is a required function by any type of module.
@@ Line 8: / Line 8: @@
 There are 2 required system attributes - a Friendly Name - this is the name that is displayed to users of your module within the WHMCS interface, and the Usage Notes which allow you to provide additional instructions to users of your module.
-Following those you can define an unlimited number of settings your module requires.  These take the format below:
+Following those you can define an unlimited number of settings your module requires.
-<source lang="php">
+===Field Definitions===
-"settingname" => array(
-    "FriendlyName" => "Display Name",
+Below are the supported configuration field types and their attributes.
-    "Type" => "xxxx",
-    // Additional attributes here
+{| class="paramstable"
-),
+|- class="tablehead"
-</source>
+|Type
 ===Code Sample===
-We'll look at all the possible setting field types and their supported attributes below.  But first, let's take a look at an example of a typical configuration function for a gateway module.
+The settings you define here will be passed into all the functions of your gateway module any time it is called.
 <source lang="php">
@@ Line 28: / Line 55: @@
              "Type" => "System",
              "Value" => "My Custom Gateway Module",
          ),
          "accountnumber" => array(
@@ Line 33: / Line 64: @@
              "Type" => "text",
              "Size" => "10",
-             "Description" => "<a href=\"#\">Click here to Signup</a>"
+             "Description" => "This can be found in Profile > Account Information"
          ),
          "apiusername" => array(
@@ Line 54: / Line 85: @@
+}
 </source>

@@ Line 1: / Line 1: @@
-<div class="docs-alert-warning">
+'''This is a required function'''
-<span class="title">Required Function</span><br />
-The config function is a required function for every gateway module where you must define the display name of your module, and any settings a user must configure for it.
+This is where you define the display name for your module, setup/usage instructions (if applicable) and any settings a user must configure for it.
 There are 2 required system attributes - a Friendly Name - this is the name that is displayed to users of your module within the WHMCS interface, and the Usage Notes which allow you to provide additional instructions to users of your module.

← Older revision	Revision as of 12:10, 10 May 2014
(No difference)