Health Check Error: Vendor files inclusion

Overview

The Health Check wizard must be run when upgrading in order to evaluate your instance's ability to move to the target version. During the health check, various types of issues may be detected which can affect your ability to upgrade. This article will cover the "Vendor files inclusion" error reported by the health check.

Symptoms

This error generates an output similar to the following in health check:

Resolution

The following type of statements will generate this health check error:

• include()
• include_once()
• require()
• require_once()

If these function calls reference a path that is relocated to the ./vendor/ directory in the target version, the health check will notify you of the offending files and occurrences found.

In this example, the require_once() statement identified in the health check error is referenced in the ./custom/include/vendorExample/Example.php file. The line of code referencing this hook is as follows:

require_once('include/nusoap/nusoap.php');

Since the file referenced in this Require_once() statement has been moved to the vendor directory, the line of code will be changed during the upgrade as follows to ensure functionality remains intact:

require_once('vendor/nusoap/nusoap.php');   

Related Health Check Error

References to certain files in the ./include/Smarty/ directory may generate the "deletedFilesReferenced" health check error. For more information regarding the "deletedFilesReferenced" error, please refer to the article Health Check Error: deletedFilesReferenced. Please note that the "Vendor files inclusion" error will also occur for references to files in the ./include/Smarty/ directory that remain after the upgrade.