Forms folder

This folder should keep the dialog forms where the user will enter parameters necessary to install/reconfigure a given application on the domain side. Also, this folder should contain event handler files referring to these forms. If the folder is empty, the installation package is invalid.

When the install/reconfiguration procedure is triggered for a web application, first the AV mechanism searches for a respective parameter input form across this folder. The parameter input form is implemented as a PHP file with its name formatted as follows:

installer-form-<step number>.php

reconfigure-form-<step number>.php

The PHP file name specifies the type of operation, indicates that the file is an input form, and specifies the step number (which is reserved for multi-step wizards).

After the user has entered the required information in the parameter input form and pressed the OK or NEXT button, Application Vault looks through this folder again, this time searching for a matching handler. A handler is a PHP file with the following name format:

installer-handler-<step number>.php

reconfigure-handler-<step number>.php

This name format is similar to the one used for forms, except it describes the file as a handler.

The following table summarizes the above information and specifies what objects should be present in the /forms folder of a valid installation package:

The table presents three important facts, that is:

• It is important that the developers always follow the naming convention when creating form and handler files, as the AV mechanism fully relies on it and just skips files with incorrect names from processing.
• A called procedure cannot be started if a respective form is missing in the /forms folder of the installation package.
• If Application Vault has received the 'button pressed' event from the form, but failed to find a matching handler, the button pressure remains unhandled, i.e. the installation/reconfiguration process cannot be completed.