Difference between revisions of "PHP Version Compatibility"

From WHMCS Documentation

(Created page with "In WHMCS 7.5 and above, you can view a report of ionCube-encoded files in your WHMCS installation directory that may not properly decode under certain versions of PHP. You ca...")
 
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
In WHMCS 7.5 and above, you can view a report of ionCube-encoded files in your WHMCS installation directory that may not properly decode under certain versions of PHP.
 
In WHMCS 7.5 and above, you can view a report of ionCube-encoded files in your WHMCS installation directory that may not properly decode under certain versions of PHP.
  
You can generate this report at '''Utilities > System > PHP Version Compatibility'''.
+
You can view this report at '''Utilities > System > PHP Version Compatibility'''.
  
This provides transparency for files that you may have deployed over the lifespan of your installation, namely files belonging to custom or 3rd party code. WHMCS does not control these files however if their encoding is incompatible with your environment they may negatively affect WHMCS.   
+
This provides transparency for files that you may have deployed over the lifespan of your installation, particularly files for custom or third-party code. WHMCS does not control these files but, if their encoding is incompatible with your environment, they may negatively affect WHMCS.   
  
 
This utility only inspects decoding compatibility and does not assert PHP syntax compatibility.
 
This utility only inspects decoding compatibility and does not assert PHP syntax compatibility.
 
__TOC__
 
 
[[File:PHP-Version-Compat-Utility.png]]
 
  
 
== Performing a Scan ==
 
== Performing a Scan ==
Line 20: Line 16:
  
 
<div class="docs-alert-warning">
 
<div class="docs-alert-warning">
<span class="title">Excluded Directories</span><br />
+
To improve performance, the system excludes the <tt>/vendor</tt>, <tt>/attachments</tt>, <tt>/downloads</tt>, and <tt>/template</tt> cache directories from inspection. These directories contain many decodable files that have no negative effect on WHMCS.
The "/vendor", attachments, downloads and template cache directories are specifically excluded from inspection. These directories may contain many files, all of which should be decodable and have no negative effect on WHMCS, and thus are not evaluated to aid performance of the utility.
 
 
</div>
 
</div>
  
Line 30: Line 25:
 
* Click '''Compatible Encoding''' to view a list of files that the selected PHP version can decode.
 
* Click '''Compatible Encoding''' to view a list of files that the selected PHP version can decode.
 
* Click '''Incompatible Encoding''' to view a list of files that the selected PHP version '''cannot''' decode.
 
* Click '''Incompatible Encoding''' to view a list of files that the selected PHP version '''cannot''' decode.
* Click '''Encoding Compatibility Unknown''' to view a list of files whose compatibility is not known.  
+
* Click '''Encoding Compatibility Unknown''' to view a list of files with unknown compatibility.  
 
** The system may be unable to determine decoding compatibility due to the way in which ionCube encodes some files.
 
** The system may be unable to determine decoding compatibility due to the way in which ionCube encodes some files.
 
** For more information, see [[PHP Version Compatibility Assessment]].
 
** For more information, see [[PHP Version Compatibility Assessment]].

Latest revision as of 19:47, 27 April 2022

In WHMCS 7.5 and above, you can view a report of ionCube-encoded files in your WHMCS installation directory that may not properly decode under certain versions of PHP.

You can view this report at Utilities > System > PHP Version Compatibility.

This provides transparency for files that you may have deployed over the lifespan of your installation, particularly files for custom or third-party code. WHMCS does not control these files but, if their encoding is incompatible with your environment, they may negatively affect WHMCS.

This utility only inspects decoding compatibility and does not assert PHP syntax compatibility.

Performing a Scan

The first time that you perform a scan, click Scan.

For later scans, click Rescan.

The scan checks your WHMCS installation for encoded files. Then, it evaluates ionCube-encoded files to determine the ionCube Encoder version.

To improve performance, the system excludes the /vendor, /attachments, /downloads, and /template cache directories from inspection. These directories contain many decodable files that have no negative effect on WHMCS.

Reading the Report

The report includes tabs for each PHP version. Under each tab, you can click the following headings to display lists of files:

  • Click Compatible Encoding to view a list of files that the selected PHP version can decode.
  • Click Incompatible Encoding to view a list of files that the selected PHP version cannot decode.
  • Click Encoding Compatibility Unknown to view a list of files with unknown compatibility.