Knowledgebase

Client Testimonials - WHMCS Module (c) 2010 Y-Net UK / Hosting Solutions

Thank you for purchasing our Client Testimonials (client reviews) Module for WHMCS. Please read all of this document before you install the module.

Before You Start!

IMPORTANT: Please make a backup of any of the files that you change on your server before you make any changes to them.

You must make sure the correct sourceguardian loaders are configured on the server you wish to run this module on.  (Please see the section "SourceGuardian™ Loaders Information / Help" at the bottom of this document."

Installation Instructions

Unzip the file client-testimonials.zip file to a folder / directory on your local machine.

Copy all the files and folders (directorys) from     whmcs_reviews_addon folder  to the folder whmcs is installed in.

Copy the folder     ixed       and all files in it to the folder whmcs is installed in. (these are the sourceguardian loader files, if you have installed sourceguardian in your php extensions then it will be server wide and does not need the ixed folder at all.

Open the file configuration.txt and copy the text to your clipboard (or notepad), then close the file.

Edit your configuration.php in your whmcs directory on your web site and add the line you just copied to your clipboard / notepad, replace the "abc123" with the License Key which you got from our clientarea when you downloaded this module (this must have " either side of the license key" ), save the configuration.php file and exit the editor.

In your whmcs directory you have subdirectory called "lang" open this directory and you will see a file called NewStrings.txt.

Open NewStrings.txt in a notepad type program and copy the contents to your clipboard or notepad.  Open your default language file (for example English.txt with a Text Editor program (like notepad) and scroll to the bottom of the file, then on a new line paste the contents of NewStrings.txt (from your notepad or clipboard).  

You must do this for every language that you use on your website.

Open a Web browser and navigate to your web site and your whmcs, log into your admin area like you would do normally. Once logged in you must navigate to the Utilites Menu in whmcs then select Add On Modules. You will then see a link to the module "Client Reviews" Please press it.

If this is the first time that you have run the "Client Reviews" module then it will ask you to press a link to create the necessary tables in your database (this is where we store all the information the module needs).  Please press the link then follow the instructions on the screen to complete the installation.

PLEASE NOTE: You will only need to install this module once, after this the configuration is stored in the database.

SourceGuardian™ Loaders Information / Help

SourceGuardian™ Loaders 

Scripts protected with SourceGuardian™ will require the installation of a SourceGuardian™ loader on the target machine in order to run. Protected scripts will automatically attempt to find the loader in the ixed/ directory located within the protected script's directory or parent directories. SourceGuardian™ loaders may also be installed into a php.ini configuration file - This is useful, for example, if automatic loading is not supported or if faster performance is required. 

For PHP versions 5.2.5+, SourceGuardian™ loaders need to be installed in the PHP extensions directory (extension_dir). You may find the extension_dir path in the php.ini configuration file or in the phpinfo() output.

The way the dynamic loading dl() function works in PHP has been changed since version 5.2.5 - It may load PHP extensions located ONLY in the extension_dir directory or a subdirectory within it. This means that SourceGuardian™ loaders cannot be loaded automatically from the ixed/ directory located within the protected script's directory or parent directories for PHP 5.2.5+. Usually you will get the following error message in that case: "Warning: dl() [function.dl]: Temporary module name should contain only filename".  Please also read the note below about installing the loader for PHP 5.2.5+.

Automatic loading 

Many operating systems and installations of PHP will load the Protected scripts without any modification.  PHP will be able to find and load the appropriate loader if the following conditions are met:

1) Operating system and PHP mode: 

Linux, FreeBSD, NetBSD, OpenBSD, MacOSX, SunOS, other UNIX - PHP installed as CGI or CLI 

Linux, FreeBSD, NetBSD, OpenBSD, MacOSX, SunOS, other UNIX - PHP installed as a webserver's module (with thread safety off) 

Windows - PHP installed as CGI or CLI 

2) Thread Safety is disabled. You may check phpinfo() output for this. 

3) dl() is enabled. You should have enable_dl=On in your php.ini. 

4) The PHP extensions directory (extension_dir) needs to exist. Please check that the extension_dir= option in php.ini points to the real directory. Some hosting companies have incorrect installations of PHP and this can 

cause problems. 

5) The latest ixed loaders are installed in an ixed/ subdirectory within your scripts directory or any parent directory. 

6) PHP version is below 5.2.5. 

Please note: if your server and PHP configuration conform to all conditions above for automatic loading except only a PHP version, then it is enough to copy an appropriate loader into the PHP extension directory (extension_dir). The loader will be used automatically from the extension_dir directory - no need for changes in the php.ini configuration file. 

Manual installation 

It is possible to manually install the loader and this is required in the following conditions: 

1) Operating system and PHP mode: 

Linux, FreeBSD, NetBSD, OpenBSD, MacOSX, SunOS, other UNIX - PHP installed as a webserver's module (with thread safety on) 

Windows - PHP installed as Apache module (thread safety is always on) 

2) If Thread Safety is enabled. You may check phpinfo() output for this. PHP installed as a webserver's module under Windows will always have Thread Safety on.

3) If dl() is disabled. You have an "enable_dl=Off" setting in the php.ini configuration file. 

Manual installation requires permissions to access the extension_dir directory and the php.ini configuration file. Manual installation may be used even if automatic loading is available. With appropriate and manually 

installed SourceGuardian™  loaders you give the maximum performance for your protected scripts. This is because the script will not need to search for a loader each time it runs. 

To install the SourceGuardian™ loader manually you need to do the following:

1) Choose an appropriate loader for your operating system and version of PHP. Please refer to the "Loader filename structure" section below to know which loader is required for your operating system and version of PHP.

2) Find the loader file in the ixed/ subdirectory within SourceGuardian main installation directory and copy it to the PHP extension directory (extension_dir - check the phpinfo() output). 

3) Find the location of the php.ini configuration file (check the phpinfo() output) and add "extension=ixed.X.X.YYY" directive at the end of the file. (X.X is the major version of PHP and YYY is the name of operating system)

4) Restart the webserver in order to apply changes done in the php.ini configuration file and reload PHP. 

5) Optionally you may check the phpinfo() output now to find out that SourceGuardian loader was successfully installed - search for "SourceGuardian" within the output.

Loader filename structure

The following provides an overview of the loader naming conventions: 

ixed.X.Y.Zdd.os 

X.Y - major PHP version number (4.3 for 4.3.x, 5.0 for 5.0.x, 5.1 for 5.1.x, 5.2 for 5.2.x) 

Z - minor PHP version number (2 for 5.0.2) This is optional and most loaders DOES NOT have the minor version number in the file name. 

This part may be missed in the loader name which means that this loader is for all higher PHP versions: 

ixed.4.3.lin - for all PHP 4.3.x versions 

ixed.5.0.0.lin - for PHP 5.0.0 only 

ixed.5.0.1.lin - for PHP 5.0.1 only 

ixed.5.0.2.lin - for PHP 5.0.2 only 

ixed.5.0.lin - for all PHP 5.0.3+ versions and higher 

ixed.5.1.lin - for all PHP 5.1 versions and higher 

ixed.5.2.lin - for all PHP 5.2 versions and higher 

dd - optional code of supported encoder and system: 

(missed) - this loader will load scripts protected with full version of SourceGuardian™ 

ts. - this loader will load scripts protected with the full version of SourceGuardian™ and is suited for 

manual installation on systems with Thread Safety enabled PHP (see details above)

os - three char code of operating system type. Currently supported: 

.win - Windows 

.lin - Linux 

.fre - FreeBSD 

.net - NetBSD 

.ope - OpenBSD 

.sun - SunOS

.dar - MacOSX (darwin)

.hp- - HPUX PA-RISC system

For some operating systems there are different versions of loaders for 32-bit and 64-bit mode. File names of such loaders are the same as it is impossible to determine 32/64-bit mode on a PHP level. Although 32-bit and 64-bit loaders are packed in different zip (tar.gz, tar.bz2) files so you can easily determine them. You need to use the correct 32-bit or 64-bit version of the loader on your system according to the platform and the mode PHP executable or shared object is built. You may safely try 32-bit version and then 64-bit one if you are unsure. Usually you will get the following error message in the case of wrong 32/64-bit loader is installed: "Unable to load dynamic library 'ixed....' cannot open shared object file" or "Unable to load dynamic library 'ixed...' wrong ELF class: ELFCLASS32(64)". If you have access to a command line shell you may check the PHP using command line "file" tool, e.g. "file /path/to/php".

How to install the loader helper

We can help you to know how to install the loader on your destination system. We have put simple php program in your our clientarea called sg4-howto-install.zip (you can only see this when yo are logged in) you need to extract the file outof that caled howto-install.php and copy it to your webserver and then access it form your web browser, this will then tell you how to install the loaders on your specific system.  

The Alternative is that you need to create a simple phpinfo script and install it on your server. The content is simple as " ". Then submit a support ticket in our clientarea which contains the weblink to access the phpinfo page on your server.  The phpinfo data will be analyzed and then we will give you instructions of how to install the loader on your server.

If when you run "howto-install.php" it says that the sourceguardian loaders are already installed but the module still looks encoded when you run it then this probably means that the loaders have been updated and you will have to find the correct loader for your system in the ixed folder and copy it over the file with the same name which alaready exists in your php extensions folder on your server.  You must then restart your webserver (such as apache for example) on your server.  If you do not know where your php extensions directory is then you can use phpinfo to tell you, if you do not have a phpinfo.php script then please submit a support ticket and we will attach one for you.