Plesk AV API Reference

This section of Plesk AV documentation contains topics for each function that can be used for programming purposes when one creates an installation package for a web application.

For more information, refer to the following topics:

check_dbName	Checks whether the format of the specified database name is valid.
check_dbUserName	Checks whether the format of the user name is valid.
check_dns_dom	Checks whether the format of the specified DNS domain name is valid.
check_domain	Checks whether the format of the specified domain name is valid.
check_email	Checks whether the email name format proposed for the email account is valid.
check_filename	Checks whether the format of the specified file name is correct.
check_idn_domain	Checks whether the UTF-8 formatted domain name is valid.
check_int	Checks whether the format of the specified numeric value is correct.
check_ip	Checks whether the specified IP address is valid.
check_mail_passwd	Verifies the format of the email password read from the current form.
check_mailname	Checks whether the format of the email box submitted by the current form is valid.
check_mask	Checks whether the specified IP mask is valid.
check_pg_login	Verifies the format of the login to a PostgreSQL database.
check_pg_passwd	Verifies the format of the password to a PostgreSQL database.
check_phone	Checks whether the format of the specified phone number is valid.
check_shortUrl	Checks whether the reduced format of the specified URL is valid.
check_sys_login	Checks whether the format of a login entered on the form is valid.
check_sys_passwd	Checks whether the format of a password entered on the form is valid.
check_url	Checks whether the format of the specified URL is valid.
sapp_check_install_prefix	Validates the specified installation folder to which the installation package will be unpacked.
sapp_create_database	Creates a new database of a certain type (MySSQL or PostgreSQL) with the user-specified name of the database.
sapp_create_database_user	Creates a new database user with the specified name in the database.
sapp_get_domain_name	Returns the name of the target domain the application will be installed on.
sapp_get_image	Forms and returns an HTML tag that will link a certain image from the `/forms` folder of the installation package.
sapp_get_install_prefix	Gets the string with the application folder from the global variable and returns it.
sapp_get_locale	Returns the locale used in the current Control Panel session.
sapp_get_new_db_name	Generates and returns the default name for the newly created database.
sapp_get_new_db_user	Generates a random user name for the specified database and returns it.
sapp_get_param	Gets and returns a certain parameter by its name from the global array of web parameters.
sapp_get_ssl	Gets the SSL status currently set for the installation.
sapp_get_submit_value	Returns the value submitted by the form that relates to the current step of the procedure.
sapp_get_wrong	Returns an error message specified for a certain parameter if this parameter is wrong.
sapp_include	Tells to the PHP interpreter that it needs to include the specified file from the `/forms` folder of the installation package.
sapp_include_once	Tells to the PHP interpreter that it does not need to include the specified file from the `/forms` folder of the installation package more than once during a particular execution of the script.
sapp_include_path	Returns the include path of the installation package.
sapp_is_database_exists	Checks whether the database with the specified name and type exists on the database server which is currently set as main in Plesk.
sapp_is_database_user_exists	Checks whether a certain DB user exists is the specified database.
sapp_is_ssl_available	Checks whether the SSL support is currently set up on the domain.
sapp_is_wrong	Checks whether the specified parameter is wrong.
sapp_open_application_url	Checks whether the application's URL can be opened.
sapp_require	Tells to the PHP interpreter that it needs to include the specified file from the `/forms` folder of the installation during a particular execution of the script.
sapp_require_once	Tells to the PHP interpreter that it does not need to include the specified file from the `/forms` folder of the installation package if this file has already been included during a particular execution of the script.
sapp_set_error	Sets an error with the specified error text and other parameters.
sapp_set_errormsg	Sets an critical error with the specified error text and identifier.
sapp_set_install_prefix	Sets a string with the application folder name and validates it.
sapp_set_param	Sets a certain parameter to the global array of web parameters.
sapp_set_ssl	Sets the SSL protected mode for the installation.
sapp_set_warning	Sets a warning with the specified text and identifier.
sapp_set_wrong	Set a certain parameter as wrong.