Worldwide (English)
Türkiye (Türkçe)
Getting StartedParameters
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/SampleHostingCP/ |
| $this->dir |
Gives the directory path where the module is located.
Example: DOCUMENT ROOT -- /coremio/modules/Servers/SampleHostingCP/ |
| $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->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 Product/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 client service.
|
| $this->order[] |
Gives the output that includes all details [array] of the product belonging to client 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"] |
The Service Status (awaiting, in process, active, suspended, un-suspended)
Database Field: users_producs.status |
| $this->order["status_msg"] |
The Service Status Error Message
Database Field: users_producs.status_msg |
| $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"]["server_features"][...] |
Properties of Server Defined to The Service (includes [array] string)
|
| $this->order["options"]["panel_type"] |
Type of Server Defined to Client Service (cPanel, Plesk, DirectAdmin or Other)
|
| $this->order["options"]["panel_link"] |
Panel URL Link Defined to The Service
|
| $this->order["options"]["established"] |
Indicates installation status of the service. True = installed. False = not installed.
|
| $this->order["options"]["domain"] |
Domain Name Information Defined to the Service
|
| $this->order["options"]["disk_limit"] |
Disk Space (MB) Information Defined to the Service
|
| $this->order["options"]["bandwidth_limit"] |
Bandwidth Limit (MB) Information Defined to the Service
|
| $this->order["options"]["email_limit"] |
EMail Limit Information Defined to the Service
|
| $this->order["options"]["database_limit"] |
Database Limit Information Defined to the Service
|
| $this->order["options"]["addons_limit"] |
Addon Domain Limit Information Defined to the Service
|
| $this->order["options"]["subdomain_limit"] |
Subdomain Limit Information Defined to the Service
|
| $this->order["options"]["ftp_limit"] |
Ftp Account Limit Information Defined to the Service
|
| $this->order["options"]["park_limit"] |
Domain Park Limit Information Defined to the Service
|
| $this->order["options"]["max_email_per_hour"] |
Hourly Email Sending Limit Information Defined to the Service
|
| $this->order["options"]["cpu_limit"] |
CPU Limit Information Defined to the Service
|
| $this->order["options"]["config"] |
Used to install access information of hosting account formed in it while the service is going to be activated. It is also used to detect installation status.
|
| $this->order["options"]["config"]["user"] |
User Name Information Defined to the Service
|
| $this->order["options"]["config"]["password"] |
Password Information Defined to the Service
|
| $this->order["options"]["ftp_info"] |
There is FTP information defined to the service, it must be an array.
|
| $this->order["options"]["ftp_info"]["host"] |
FTP Server Address, without ftp:// at the beginning
|
| $this->order["options"]["ftp_info"]["port"] |
FTP Port
|
| $this->order["options"]["ftp_info"]["username"] |
FTP User Name
|
| $this->order["options"]["ftp_info"]["password"] |
FTP Password
|
| $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.
|
| $this->val_of_requirements |
It contains the requirement information filled in at the order step.
|
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_requirements["Backup"]$this->val_of_conf_opt["Extra IP"]