General

From ModulesGarden Wiki
Jump to: navigation, search

Contents

How To Change WHMCS Module Language

Please note that not all of our modules are provided with Multi-Language Support.

1. Changing WHMCS module language is very simple. First of all, go to 'lang' folder located in your module or templates directory.

Important:
1. Depending on the module the directory may very.
2. There might be two language files located in different directories, separately for Admin Area and Client Area.
You may decide whether you wish to translate both of them or only one.

Copy 'english.php' file and rename the newly copied directory with your desired language, for example 'spanish.php'.

Lang1.png
2. Open your personalized file now and replace particular sentences with ease.

For presentation purposes we changed ['manage header'] from 'Manage' to 'Ordenar'. Do not forget to save the changes!

Lang2.png
3. There are two ways you can alter the language:
  • Change the client's language in your WHMCS system:
Lang4.png
  • Change the language directly in the client area (keep in mind that customers can change their language anytime they want):
Lang5.png
4. Take a look at the screen and you will see that the header has changed to 'Ordenar', which is a direct consequence of our modifications.
Lang3.png
Act accordingly to the above instructions to implement any changes in the language files of our modules.
In case you have any doubts or encounter any problems we will do our best to provide you with adequate assistance.

How To Change Magento Extension Language

1. In order to change Magento extension language follow the steps shown below.

Go to 'your_magento\app\locale\' where you can find language files.
Choose language folder that you desire to translate from and find the file bounded to the extension.
For the purposes of an example, we will create a Polish language file for GPN DATA For Magento .
Copy 'Modulesgarden_Gpndata' file from 'en_US\' folder to 'pl_PL\' folder.

HCLM 1.png
2. Edit the previously created file in 'pl_PL\' folder. As you can see, each line consists of two phrases.

First one (underlined with green) is a phrase in English which determines phrase to translate.
Second one (underlined with red) is a phrase which will be displayed. On the following screen it is Polish translation for 'Gateway URL' .

HCLM 2.png
3. Log in to your Magento admin area and proceed to 'System' 'Configuration' .

Choose desired language from 'Locale' dropdown menu under 'Locate Options' section as shown on the following screen.
To see changes that you made, re log in to your account.

HCLM 3.png
4. As you can see on the screen below, the 'Gateway URL' was replaced by 'Adres URL Bramki' owing to our changes.
HCLM 4.png
That's all, from now on you should not have any problems with changing language in our Magento modules.

How To Change Magento Admin Theme

Proceed with step listed below in order to upload and enable custom admin panel theme.
1. Download desired admin panel theme archive.
2. Upload and extract the theme archive into the main Magento directory.

Files in your Magento directory should look like this.

G MAT 1.png
3. Log in to the Magento admin panel, clear cache and proceed to 'System' 'Configuration' .

Now, press 'Design' under 'General' section.

G MAT 2.png
4. Press 'Admin Theme' and choose a previously uploaded theme from a dropdown menu.

Confirm through pressing 'Save Config' .

G MAT 3.png
5. Congratulations, you can enjoy your new admin panel theme!
G MAT 4.png

Common Problems With Magento Extensions

This section contains tips and tricks of solving problems related to Magento extensions' behaviour.

Before Extension's Activation

During the extension activation process we recommend disabling Compiler.

1. Proceed to 'System' 'Tools' 'Compilation' and disable the Compiler.
2. Install the extension.
3. Recompile the Magento system.
4. Activate the Compiler.
Note: If you encounter any problems with deactivation of the compiler, simply log into your Magento FTP account and rename 'include' folder.

After Extension's Activation

If you encounter any problem after activation of our extension, ensure that you:

1. Cleared the Magento cache under 'System' 'Cache Management' .
2. Re-logged in to your Magento admin panel.

Other Issues

1. Missing logs in '/var/log' folder.

Solution: Set up 'var' folder as writable.
Proceed to 'System' 'Configuration ' 'Developer ' and select 'Yes' from 'Enabled' dropdown menu under 'Log Settings' section.

How To Debug Module

If the procedure described below doesn't work for you, please report it to our Support Team.

When you are experiencing white page or the module is not working as it should, you can enable debug mode that prints all the PHP errors on the screen.
To do so, enter the URL you are experiencing the issue with and add an additional parameter '_debug=turnon'. For example:

yourdomain.com/clientarea.php?action=productdetails&id=81&_debug=turnon
yourdomain.com/clientarea.php?_debug=turnon

To disable debug mode, simply call the same parameter but with value turnoff. For example:

yourdomain.com/clientarea.php?_debug=turnoff

If you get the error as shown on the screen below, please make sure that you are using the correct parameter and you have sufficient privileges.
DM1.png

How To Solve Problems With Module License

In case you encounter any problems with the license, please read through the below points to find a solution.
1. Make sure your license key applies to the used license. For example:
  • If you had a trial version and then bought a full version (separately), then the license key must be changed.
  • If you own a trial version and then upgrade it to a full version, then a trial license key should be used.

If you want to learn more about upgrades, please follow here.

2. Check if License_RENAME.php file has been removed (or renamed).
3. Make sure your license file content format is correct.

Former license format (no longer supported):

<?php
/*
 * LICENSE:
 * Please provide your DNS Manager Module For WHMCS license below
 */
$dns_manager_licensekey="ModulesGarden_DNSManager_xxxxxxxxxxxx";
?>

Current and correct license file format:

<?php
/*
 * LICENSE:
 * Please provide your DNS Manager Module For WHMCS license below
 */
$dns_manager_licensekey="ModulesGarden_DNSManager_xxxxxxxxxxxx";
Please note that the blow symbol is no longer used:
?>
4. Check if your firewall does not block our domain: modulesgarden.com.
5. In case you see an error:

Order Accept Encountered Problems
License Invalid: MD5 Checksum Verification Failed

Make sure all module files are correctly downloaded and installed.

6. If, despite checking all of the above pieces of advice, problems with you license persist, try to reissue your license.

To to so, log in to your client area, choose a product and click on 'Management Actions' 'Reissue License'.

G1.png
In case of further issues, please contact our support team.

How To Use Configurable Options

Configurable options on products allow you to give your clients variables which alter the resource available at that product as well as its price.

In this tutorial we will show you how to manage configurable options generated by our modules.

Editing Configurable Options

When you successfully set up a product, your client can order it by choosing its resource and settings from default configurable options.
HCO1.png
In case those options do not suit your needs, you can edit them.

To do so, go to 'Setup' 'Products/Services' 'Configurable Options' and press edit button next to configurable option used by your product.
Its name is 'Configurable options for your_product_name' .

HCO2.png
Here you can view all products this configurable option group is assigned to.

Now we will show you how to edit options. Let's say you want to add an option to order VPS with 4 cores per socket.
To do so, edit 'The number of cores per socket' by pressing edit button as shown on the screen below.

HCO3.png
You will see a popup window, so make sure your browser will not block it.

To add a new option enter it in a textbox under all other options, but if you want to replace it with an option you currently have, simply edit its textbox.
Next, press 'Save Changes' .

HCO4.png

Hiding Configurable Options

If you decide to hide configurable options from a client order form and manage them only from the admin area, follow steps below.

Firstly, go to 'Setup' 'Products/Services' 'Configurable Options' .

HCO5.png
Afterwards, tick 'Hidden' checkboxes next to configurable options you want to hide and confirm the action through pressing 'Save Changes' .

On the screen below you can see hiding of 'Number of Public IP' and 'Number of Private IP' .

HCO6.png

Setting Up Pricing For Configurable Options

If you decide to set up pricing for configurable options, follow steps below.

Firstly, go to 'Setup' 'Products/Services' 'Configurable Options' .

HCO7.png
Next, press edit button next to configurable options you want to set pricing for.
HCO8.png
Afterwards, you will see a popup window, so make sure your browser will not block it.

Now, price you entered for resource should be in a column responsible for the same type of payment as your product uses.
For example, if we have product with monthly and quarterly payment, you will have to enter product pricing in the first and second columns.
Confirm through clicking on 'Save Changes' button as soon as you finish.

HCO9.png
Depending on 'Option Type' , pricing you entered may be counted in various ways.

'Dropdown' - You have to set price for each option. On the screen below you can find examplary setup of 'Dropdown' type configurable option.
'Radio' - Same as above, only difference is display manner.
'Yes/No' - Your price will be applied if client checkes this option.
'Quantity' - Price you set will be multiplied by amount of configurable options your client chooses.

HCO10.png
On the screen below you can see specially prepared all four configurable options on the order form.
HCO11.png
Now you should have no problems with understanding and using the configurable options in your WHMCS.
Personal tools
Namespaces

Variants
Actions
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
General