User Guide and Documentation

VariablesRelease Date: 2019/07/29

Variable Type Description
$config Array() Returns the contents of the “config.php" file by the __construct() function.
$lang Array() Returns the contents of the php file in the “lang” folder by the __construct() function.
$error String When a function in the class is launched and boolean (false) is restored in return, the contents of the $error variable are transmitted to the client.
$whidden Array() The __construct() function defines the information of the whois privacy protection fee defined in the setting file.
$order Array() The order information of the domain name is assigned by the set_order() function.


Values Retrieved from Variables

$config output:

It calls the content of the “config.php” file.

Array
(
 [meta] => Array
 (
   [name] => ExampleRegistrarModule
   [version] => 1.0
   [logo] => logo.png
 )

[settings] => Array
 (
   [username] => example
   [password] => SWlUTS9kVvaVRhSDRraVIrST0=
   [test-mode] => 0
   [whidden-amount] => 0
   [whidden-currency] => 4
   [adp] => 0
   [cost-currency] => 4
 )
)

 

Index Description
[meta] It is the index that contains information such as the name of the module, version number, and logo.
[meta][name] The index that contains the name of the module
[meta][version] It is used to identify the version number of the module.
[meta][logo] It is used to determine the image of the module appears on the settings page, the image must be in the module directory.
[settings] The index that contains the fields on the module's settings page.
[settings][…] You can add fields that you specify yourself, optionally.
[settings][test-mode] It is added as standard, you can optionally remove it.
[settings][whidden-amount] The index that specifies the Whois privacy fee.
[settings][whidden-currency] The index that specifies the currency of Whois privacy fee.  
[settings][adp] It is used to automatically price the domain name extensions. Value: 1 if active, 0 if not.
[settings][ cost-currency] It is used to automatically price the domain name extensions. It specifies the currency of retrieved cost information. Its value is determined according to the "id" value on the "currencies" table in the database.

 

$lang output:

It calls the content of “lang /*.php file.

Array
(
[name] => ExampleRegistrarModule
[description] => 
[fields] => Array
(
[username] => Username
[password] => Password
[test-mode] => Sandbox / Test Mode
[WHiddenAmount] => Whois Protection Fee
)

[desc] => Array
(
[username] => enter the username
[password] => enter the password
[test-mode] => Activate to process in test mode.
)

[tab-detail] => API Information
[tab-import] => Import
[test-button] => Test Connection
[import-note] => You can easily transfer the domain names found on the service provider to your existing clients. When you do this, the domain name will be defined as an order for your client. The domain names already registered in the system are coloured green.
[import-button] => Import
[save-button] => Save settings
[error1] => The API information is not available.
[error2] => Domain and extension information did not come.
[error3] => An error occurred while retrieving the contact ID.
[error4] => Failed to get status information.
[error5] => The transfer information could not be retrieved.
[error6] => Please enter the API information.
[error7] => The import operation failed
[error8] => An error has occurred.
[success1] => Settings saved successfully.
[success2] => The connection test succeeded.
[success3] => Import completed successfully.
)

$whidden output:

Array
(
[amount] => 0
[currency] => 4
)

$order output:

Array
(
[id] => 123
[owner_id] => 75
[invoice_id] => 696
[type] => domain
[type_id] => 0
[product_id] => 7
[name] => example.com
[period] => year
[period_time] => 1
[total_amount] => 9.9900
[amount] => 9.9900
[amount_cid] => 4
[status] => active
[status_msg] => 
[pmethod] => BankTransfer
[cdate] => 2019-07-17 17:17:00
[duedate] => 2020-07-17 17:17:00
[renewaldate] => 2019-07-17 17:17:00
[process_exemption_date] => 0000-00-00 23:59:59
[module] => ExampleRegistrarModule
[options] => Array
(
[group_name] => Domain Names
[local_group_name] => Domain Names
[category_id] => 0
[domain] => example.com
[ns1] => ns1.ownersample.com
[ns2] => ns2.ownersample.com
[ns3] => ns3.ownersample.com
[name] => example
[tld] => com
[whois_privacy] => 1
[whois_privacy_endtime] => 2020-07-17 17:59:59
[dns_manage] => 1
[epp_code_manage] => 1
[whois_manage] => 1
[transferlock] => 1
[cns_list] => Array
(
[1] => Array
(
[ns] => ns1.example.com
[ip] => 127.0.0.1
)

[2] => Array
(
[ns] => ns2.example.com
[ip] => 127.0.0.2
)
)

[whois] => Array
(
[Name] => John Doe
[FirstName] => John
[LastName] => Doe
[Company] => WISECP
[AddressLine1] => sample sample test sample test
[AddressLine2] => test test
[ZipCode] => 0000
[State] => NY
[City] => New York
[Country] => US
[PhoneCountryCode] => 1
[Phone] => 2025550103
[FaxCountryCode] => 1
[Fax] => 2025550103
[EMail] => myexample@gmail.com
)

[transferlock_latest_update] => 2019-07-19 14:18:51
[pricing-type] => 1
[config] => Array
(
[x] => xx
)
[established] => 1
)

[notes] => 
[unread] => 0
)
Copyright © 2019. All rights reserved.
Top