WHMCS模块参数—-中英对照

和上一个一样,是来自于官网,使用软件翻译的,请自己理解

Module Parameters

The module parameters are the data/values passed into each function when called. Every provisioning module function receives the same parameters. These parameters provide information about the specific product/service the module command runs for. The parameters also contains the settings from the product itself.

Variable NameDescription
serviceidThe unique ID of the service.
Database Field: tblhosting.id
pidThe product ID for the service.
Database Field: tblproducts.id
serveridThe assigned server ID for the service.
Database Field: tblservers.id
domainThe domain entered by the customer when ordering.
Database Field: tblhosting.domain
usernameUsername generated for the service. (defaults to first 8 letters of the domain)
Database Field: tblhosting.username
passwordPassword generated for the service. (10 char generated on first creation consisting of letters & numbers, both upper & lowercase).
Database Field: tblhosting.password
producttypeThe product type which can be one of hostingaccount, reselleraccount, server or other.
moduletypeThe module name (will match filename of module).
configoptionXwith X being from 1 to 24.
These fields contain the module settings for the product defined in the ConfigOptions function.
clientsdetailsContains an array of all client details service owner. This contains things like firstname, lastname, email, address1, country, etc…
customfieldsContains an array of all custom fields defined on the product.
The key is the custom field name – $params[‘customfields’][‘Field Name’].
configoptionsContains an array of all the configurable options defined on the product.
Again the key being the option name in this case – $params[‘configoptions’][‘Option Name Here’].
servertrue/false – Is the product assigned to a server.
serveripThe IP Address of the selected server.
serverhostnameThe Hostname of the selected server.
serverusernameThe Username of the selected server.
serverpasswordThe Password of the selected server.
serveraccesshashThe Access Hash of the selected server.
serversecuretrue/false – Is an SSL connection enabled in the Server Configuration.
serverportThe server port if module supports override with custom port

Config Options

Config Options (do not confuse with Configurable Options) are the module’s settings. These are defined in the ConfigOptions function of the module. Config Options are set on a per product basis. Supplied as a numbered list: $params[‘configoption1’], $params[‘configoption2’], etc. Defined by the order specified in the ConfigOptions function of the module.

Note: Every module function except the _ConfigOptions function receives the $params array. The _ConfigOptions function is unique because it is the only function that is not called in relation to a specific client instance of a product or service.

Custom Fields & Configurable Options

Values from any custom fields & configurable options are passed into modules as parameters. Passed as an array with the key being the name of the field or option.

For example for a custom field called “Username”, would become $params[‘customfields’][‘Username’]. Likewise, a configurable option named “Disk Space”, would become $params[‘configoptions’][‘Disk Space’].

 

 

模块参数

模块参数是调用时传递到每个函数的数据/值。每个预配模块函数都接收相同的参数。这些参数提供有关模块命令运行的特定产品/服务的信息。参数还包含产品本身的设置。

变量名称描述
服务服务的唯一 ID。
数据库字段:tblhosting.id
Pid服务的产品 ID。
数据库字段:tblproducts.id
服务器 id为服务分配的服务器 ID。
数据库字段:tblservers.id
客户在订购时输入的域。
数据库字段:tblhosting.域
用户为服务生成的用户名。(默认为域前 8 个字母)
数据库字段:tblhosting.用户名
密码为服务生成的密码。(第一次创建时生成的 10 个字符,由字母和数字(大写和小写)组成)。
数据库字段:tblhosting.密码
产品类型可以是托管帐户、经销商帐户、服务器或其他产品类型之一。
模块类型模块名称(将匹配模块的文件名)。
ConfigoptionxX 从 1 到 24。
这些字段包含配置选项功能中定义的产品的模块设置。
客户细节包含所有客户端详细信息服务所有者的数组。这包含诸如名字,姓氏,电子邮件,地址1,国家等…
自定义字段包含在产品上定义的所有自定义字段的数组。
键是自定义字段名称 – $params自定义字段””字段名称”。
忏说包含产品上定义的所有可配置选项的数组。
再次键是在这种情况下的选项名称 – $params”忏说”=”选项名称在这里”。
服务器真/假 – 产品是否分配给服务器。
服务器所选服务器的 IP 地址。
服务器主机名所选服务器的主机名。
服务器用户名所选服务器的用户名。
服务器密码所选服务器的密码。
服务器访问哈希所选服务器的访问哈希。
服务器真/假 – 在服务器配置中是否启用了 SSL 连接。
服务器端口如果模块支持使用自定义端口重写,则服务器端口

配置选项

配置选项(不要与可配置选项混淆)是模块的设置。这些在模块的配置选项函数中定义。配置选项根据每个产品进行设置。作为编号列表提供:$params”configoption1″,$params”configoption2″等。由模块的”配置选项”功能中指定的顺序定义。

注:除函数外,_ConfigOptions每个模块函数都$params数组。_ConfigOptions函数是唯一的,因为它是与产品或服务的特定客户端实例不调用的唯一函数。

自定义字段和可配置选项

来自任何自定义字段和可配置选项的值作为参数传递到模块中。作为数组传递,键是字段或选项的名称。

例如,对于名为”用户名”的自定义字段,$params自定义字段””用户名”。同样,名为”磁盘空间”的可配置选项$params”磁盘空间”。”磁盘空间”。”磁盘空间”。”磁盘空间”,将变为”磁盘空间”。”磁盘空间”,”磁盘空间”。”磁盘空间”,”磁盘空间”,”磁盘空间”,”磁盘空间”,”磁盘空间”,”磁盘空间”,”磁盘空间”,”磁盘空间”,”磁盘空间”,”磁盘空间”

 

© 版权声明
THE END
喜欢就支持一下吧
点赞8 分享
评论 抢沙发
头像
欢迎您留下宝贵的见解!
提交
头像

昵称

取消
昵称常用语 夸夸
夸夸
还有吗!没看够!
表情代码图片

    暂无评论内容