Developer Center

EN

Parameters

The parameters specified here describe the predefined variables within the class.

Variable Name Description
$this->url
Gives the directory where module is located as an URL address.
Example: https://.../coremio/modules/Servers/SampleServerCP/
$this->dir
Gives the directory path where the module is located.
Example: DOCUMENT ROOT --/coremio/modules/Servers/SampleServerCP/
$this->error
If you need to return failed result in the function, you can place the error message in this variable.
$this->_name
Name of the Module
$this->lang[]
System automatically specifies which language to be selected, it brings the content of php file in "lang/" directory.
$this->entity_id_name
It is the variable that specifies the name that identity number belonging to the virtual server will be saved with in configuration options of the service after installation of virtual server is successfully completed. It comes defined as "vm_id."
$this->page
If a page in module is called while navigating in client detail page, name of the page is stored in this variable.
$this->area_link
It includes the URL link of Client or Administrator service detail page.
$this->server["name"] Host name information or name of selected server.
$this->server["username"] User name of the selected server.
$this->server["password"]
Password of the selected server.
$this->server["access_hash"]
Access key of the selected server.
$this->server["secure"]
If SSL is active in the server configuration returns as true, otherwise returns as false.
$this->server["port"]
PORT information of the selected server
$this->user[]
Includes all details of client that belongs to the service detail page as [array] type.
$this->user["id"]
Client ID Number
Database Field: users.id
$this->user["name"]
Client First Name
Database Field: users.name
$this->user["surname"]
Client Last Name
Database Field: users.surname
$this->user["full_name"]
Client Full Name
Database Field: users.full_name
$this->user["email"]
Client E-Mail Address
Database Field: users.email
$this->user["phone"]
Client GSM Number (Without +)
Database Field: users.phone
$this->user["lang"]
Client Defined Language Code (Ex: en, de, fr, tr, etc.)
Database Field: users.lang
$this->user["country"]
Client Defined Country Code (Ex: US, DE, FR, TR etc.)
Database Field: users.country
$this->user["address"]
Client's Default Defined Address Information (Contains Array)
Database Field: users_addresses
$this->user["address"]["country_name"]
Address Country Name
$this->user["address"]["country_code"]
Address Country Code (US, DE,TR,FR etc.)
$this->user["address"]["city"]
Address City Name
$this->user["address"]["counti"]
Address County name
$this->user["address"]["zipcode"]
Address Postal Code
$this->product[]
Gives the output of all details [array] of the product belonging to the service.
$this->order[]
Gives the output that includes all details [array] of the product belonging to the service.
$this->order["id"]
Client Service ID Number
Database Field: users_products.id
$this->order["name"]
Client Service Product Name
Database Field: users_producs.name
$this->order["period"]
Type of Client Service Pricing Cycle Period (day, week, month, year)
Database Field: users_producs.period
$this->order["period_time"]
Client Service Pricing Cycle Period Duration
Database Field: users_producs.period_time
$this->order["amount"]
The Service Amount Information
Database Field: users_producs.amount
$this->order["total_amount"]
The Service Total Amount Info (Including Add-ons)
Database Field: users_producs.total_amount
$this->order["amount_cid"]
The Service Currency ID Number (Database Field: currencies.id)
Database Field: users_producs.amount_cid
$this->order["status"]
Müşteri Hizmetinin Durumu (awaiting,inprocess,active,suspend,unsuspend)
Veri Tabanı Alanı: users_producs.status
$this->order["status_msg"]
The Service Status (awaiting, in process, active, suspended, un-suspended)
Database Field: users_producs.status
$this->order["pmethod"]
The Service Payment Method
Database Field: users_producs.pmethod
$this->order["cdate"]
The Service First Payment Date
Database Field: users_producs.cdate
$this->order["renewaldate"]
The Service Renewal Date
Database Field: users_producs.renewaldate
$this->order["duedate"]
The Service Last Payment Date
Database Field: users_producs.duedate
$this->order["module"]
The Service Module Name
Database Field: users_producs.module
$this->order["options"]
The Service Configuration Settings
Database Area: users_producs.options
$this->order["options"]["server_id"]
Server ID Number Which The Service Is Connected (Database Field: servers.id)
$this->order["options"]["hostname"]
HostnameInformation Defined to the Service
$this->order["options"]["ip"]
IP Information Defined to the Service
$this->order["options"]["ns1"]
NS1 Information Defined to the Service
$this->order["options"]["ns2"]
NS1 Information Defined to the Service
$this->order["options"]["server_features"][...]
Properties of Server Defined to the Service (includes [array] string)
$this->order["options"]["panel_type"]
Type of Server Defined to Client Service (WHM, Plesk or Other)
$this->order["options"]["panel_link"]
Panel URL Link Defined to The Service
$this->order["options"]["login"]["username"]
User Name Defined to the Service
$this->order["options"]["login"]["password"]
Password Defined to the Service
$this->order["options"]["descriptions"]
Additional Information Defined to the Service
$this->order["options"]["assigned_ips"]
Additional IP Addresses Defined to the Service (separated by commas)
$this->order["options"]["established"]
Indicates installation status of the service. True = installed. False = not installed.
$this->order["options"]["config"]
Used to insert the identity number of the virtual machine that is created in it during the service activation. It is also used to determine the status of the installation.
$this->order["options"]["creation_info"]
There are fields in arrays in the configuration options that are available on the product.
$this->val_of_conf_opt
There are corresponding values in the 'configurable-option-params' array which is located in config.php file.

Configuration Options

Configuration options saved in product/service of client are in $this- >order["options"]["creation_info"] variable, a sample call is as follows.

$this->order["options"]["creation_info"]["example1"];

Configuration options saved in product are in $this->product["module_data"] variable, a sample call is as follows.

$this->product["module_data"]["example1"];

Configurable Options

You can call the module parameters in the special fields and add-ons selected by the client during the ordering process as follows.

$this->val_of_conf_opt["RAM"]
$this->val_of_conf_opt["Disk Space"]
$this->val_of_conf_opt["Operating System"]
Supported Functions Fixed Functions and Return

Do you have any questions?

Feel free to contact us
Contact Us
Copyright © 2020. All rights reserved.
Join Our Discord Channel
Top