Settings

Locale PHP Script: INSTALL_DIR/applications/default/app/lang/locale.php.

The PHP constants defined below can be modified to customize some labels and the navigation menu logo of your Web app.

PHP Constants

LC_PAGE_TITLE, LC_HEAD_TITLE, LC_FOOTER_LEFT, LC_FOOTER_CENTER, LC_FOOTER_RIGHT, LC_HEAD_IMG_LOGO

App configuration PHP Script: INSTALL_DIR/applications/default/app/config.php.

The following parameters are required to connect your Web App to a MySQL database and so, query data through the \DAO and \SimpleDAO ZnetDK classes, both based on the PHP PDO class.

See Getting Started | Connecting to a database for more information.

PHP Constants

CFG_SQL_HOST, CFG_SQL_PORT, CFG_SQL_APPL_DB, CFG_SQL_APPL_USR, CFG_SQL_APPL_PWD, CFG_SQL_TRACE_ENABLED

To limit access to your application to only authorized users, authentication must first be enabled (see CFG_AUTHENT_REQUIRED PHP constant).

Next, authorized users can be declared via the User Management form.

In addition, user rights on menu items and data can be restricted by adding profiles through the Profile Management form (see Profile management and user rights).

PHP Constants

Enabling authentication CFG_AUTHENT_REQUIRED

Session settings CFG_SESSION_DEFAULT_MODE, CFG_SESSION_SELECT_MODE, CFG_SESSION_TIMEOUT, CFG_SESSION_ONLY_ONE_PER_USER

Password settings CFG_DEFAULT_PWD_VALIDITY_PERIOD, CFG_CHECK_PWD_VALIDITY, CFG_CHECK_PWD_LENGTH_REGEXP, CFG_CHECK_PWD_LOWERCASE_REGEXP, CFG_CHECK_PWD_UPPERCASE_REGEXP, CFG_CHECK_PWD_NUMBER_REGEXP, CFG_CHECK_PWD_SPECIAL_REGEXP

Login settings CFG_NBR_FAILED_AUTHENT, CFG_LOGIN_THROTTLING_ATTEMPTS_BEFORE_LOCKOUT, CFG_LOGIN_THROTTLING_LOCKOUT_DELAY, CFG_LOGIN_THROTTLING_ATTEMPTS_WINDOW_TIME

Forgot password settings CFG_FORGOT_PASSWORD_ENABLED, CFG_FORGOT_PASSWORD_REQUEST_TRACE_ENABLED

Application version CFG_APPLICATION_VERSION

App configuration PHP Script: INSTALL_DIR/applications/default/app/config.php.

Parameters to enable user authentication and configure the user session.

See Getting Started | Enabling user authentication for more information.

 Constant CFG_FORGOT_PASSWORD_ENABLED

TYPE Boolean

DESCRIPTION Displays a 'Forgot your password?' anchor on the login form.

For security reasons, this anchor is only displayed if the user has succeeded in authenticating at least once on his terminal.

When clicked, the modal dialog corresponding to the view forgotpassword.php is shown to request a new password from a user email address (this view can be customized by copying it into the view folder of the application or a module).

To send emails to the user who has requested a new password, You need to add a custom app\controller\ForgotPassword class in your application (or mymodule\mod\controller\ForgotPassword in your own module) and implement the two following public static methods.

• sendConfirmation($emailAddress, $confirmationUrl): this method is automatically called each time a user requests a new password by entering their email address. It is responsible for sending a message at the specified email address ($emailAddress parameter) asking the user for confirmation by clicking an hyperlink (the URL is given by the $confirmationUrl parameter) before sending a temporary password.

• sendNewEmail($emailAddress, $tempPassword): this method is automatically called when a user confirms that he requests a new password by clicking on the link received by email. It is responsible for sending a temporary password (given through the $tempPassword parameter) at the specified email address ($emailAddress parameter).

Be sure the zdk_user_pwd_resets SQL table exists in the database (see Security SQL Tables).
For an example of sending emails with PHPMailer, please visit the section Sending email with PHPMailer on this website.

DEFAULT VALUE FALSE

VERSION >= 2.5

EXAMPLE 1: config.php, display of the Forgot your password? link

define('CFG_FORGOT_PASSWORD_ENABLED', TRUE);

EXAMPLE 2: forgotpassword.php, emails sent via a custom app/controller/ForgotPassword class

<?php
namespace app\controller;
/* PHP script named 'forgotpassword.php' installed into the following directory:
   'INSTALL_DIR/applications/default/controller/'
*/
/* PHPMailer is directly installed into the application */
use PHPMailer\PHPMailer\PHPMailer;
require 'app/phpmailer/src/Exception.php';
require 'app/phpmailer/src/PHPMailer.php';

class ForgotPassword extends \AppController {
    /* Send email for confirmation */
    static public function sendConfirmation($emailAddress, $confirmationUrl) {
        $subject = 'Confirm your request for a new password';
        $body = "Hello<br>Confirm your request by clicking <a href=\"{$confirmationUrl}\">this link</a>.";
        if (!self::sendMail($emailAddress, $subject, $htmlMessage)) {
            throw new \Exception('Unable to send email for confirmation!');
        }
        return TRUE;
    }
    /* Send password by email after confirmation */
    static public function sendNewEmail($emailAddress, $tempPassword) {
        $subject = 'Your new temporary password';
        $body = "Hello<br>Here is your temporary password: <b>{$tempPassword}</b>";
        if (!self::sendMail($emailAddress, $subject, $htmlMessage)) {
            throw new \Exception('Unable to send temporary password!');
        }
        return TRUE;
    }
    /* Example of private sendMail method based on PHPMailer. Email is sent via PHP mail */
    static private function sendMail($emailAddress, $subject, $htmlMessage) {
        $mail = new PHPMailer();
        $mail->setFrom('admin@example.com');
        $mail->addAddress($emailAddress);
        $mail->Subject = $subject;
        $mail->msgHTML($htmlMessage);
        return $mail->send();
    }
}
?>

User management

ZnetDK includes in standard a dedicated view to manage the users authorized to access to the Web Application.

To manage users, the following requirements must be fulfilled:

1. A menu item is defined in the menu.php of the application to access to the z4musers.php view (see procedure).
2. The Web App is connected to a MySQL database (see procedure).
3. The Security SQL tables for storing user authentication data must have been created in the database (see procedure).

To give access to users in the Web Application, follow the procedure Declaring the users.

Rights are generally granted to users though Profiles.

However, if no particular restriction applies to users, then no profile is required. Users must simply be declared with the Menu Access Full option checked.

Profile management and user rights

ZnetDK includes in standard a dedicated view to manage user profiles that can be assigned to users in order to restrict their rights in the Web Application.

To manage profiles, the following requirements must be fulfilled:

1. A menu item is defined in the menu.php of the application to access to the z4mprofiles.php view (see procedure).
2. The Web App is connected to a MySQL database (see procedure).
3. The Security SQL tables for storing user authentication data must have been created in the database (see procedure).

A profile is generally created to restrict access to menu items in the application. In that case, the Menu Access Full option must be unchecked when assigning the profile to users.

It can also be defined to limit the visibility of the data when it is for some confidential, for example according to the department in the company in which the user works.

A profile can also be used to add specific functionalities to certain users or, on the contrary, to remove particularly sensitive functionalities.

When editing a user, one or several profiles can be assigned to him according to the rights we want to grant him.

The PHP API provides useful methods like \controller\Users::hasProfile() and \controller\Users::hasMenuItem() to grant specific rights to users programmatically based on their profiles and the menu items they have access to.

User panel

The User panel is displayed when clicking the user icon on the App header.
Only authenticated users have access to the User panel (see CFG_AUTHENT_REQUIRED parameter).

The following screens are displayed when you click the corresponding User panel button.

Password screen

The Password screen allows authenticated users to change their login password if they wish. This screen is identical to the one displayed when the user's password has expired (see Password validity period).

My user rights screen

In version >= 2.7, the My user rights screen gives information about the user profiles assigned to the logged-in user. In addition, it indicates if user has a full access to the menu of the Application.

Installation screen

In version >= 2.7, the Installation screen helps users on PWA installation procedure on their mobile devices (see Easing installation for more information about Progressive Web Application).
This screen can also be displayed in JavaScript by calling the znetdkMobile.install.showInstallView JS API method.

Uninstallation screen

In version >= 2.7, the Uninstallation screen helps users on PWA uninstallation procedure on their mobile devices (see Easing installation for more information about Progressive Web Application).
This screen can also be displayed in JavaScript by calling the znetdkMobile.install.showUninstallView JS API method.

Password validity period

When a user logs into the application, if their password has expired (see Expire on entry field in the Edit a profile form), they are asked to renew it.

To renew their password, users have to enter the following informations:

• Original password: this is the original password which has expired and needs to be changed.
• New password: the new password which replaces the expired password.
• Confirmation: the confirmation of the new password (the same than the one entered for the New password field).

Users can also renew their password before it has expired from the User panel.

To be changed, the new password must comply with the input rules defined through the CFG_CHECK_PWD_LENGTH_REGEXP, CFG_CHECK_PWD_LOWERCASE_REGEXP, CFG_CHECK_PWD_UPPERCASE_REGEXP, CFG_CHECK_PWD_NUMBER_REGEXP, CFG_CHECK_PWD_SPECIAL_REGEXP parameters.

Since version >= 3.3, as a new password is entered, compliance with the password entry rules (minimum length, upper and lower case letters, numbers, etc.) is displayed dynamically.

User account Disabled or Archived

Users can't log in to the application if their account is Disabled or Archived (see Status radio buttons in the Edit a profile form).

if the CFG_NBR_FAILED_AUTHENT constant is set to a value higher than 0, users are automatically Disabled when they enter a wrong password multiple times.
Although disabled, they can request a new password by clicking on the Forgot password? link (see CFG_FORGOT_PASSWORD_ENABLED parameter).

Finally, when users are Archived, they can no longer log into the application or request a new password.

App configuration PHP Script: INSTALL_DIR/applications/default/app/config.php.

Colors, font and logos can be customized through the parameters described below.

See Getting Started | Customizing the Starter Application for more information.

PHP Constants

CFG_MOBILE_W3CSS_THEME, CFG_MOBILE_CSS_FONT, CFG_MOBILE_CSS_FONT_FAMILY, CFG_MOBILE_FAVICON_CODE_FILENAME, CFG_MOBILE_FAVICON_DIR, CFG_MOBILE_W3CSS_THEME_COLOR_SCHEME

App configuration PHP Script: INSTALL_DIR/applications/default/app/config.php.

Additional CSS stylesheets and JavaScript libraries can be loaded for extending the web application capabilities through the following parameters.

PHP Constants

App configuration PHP Script: INSTALL_DIR/applications/default/app/config.php.
Locale PHP Script: INSTALL_DIR/applications/default/app/lang/locale.php

By default, the Starter App shipped with ZnetDK 4 Mobile is configured to be displayed in English (CFG_DEFAULT_LANGUAGE parameter set to 'en' in the config.php of the application).

The core features of ZnetDK are translated in English, French and Spanish.
To display your Web APP in French, set CFG_DEFAULT_LANGUAGE to 'fr'. For a display in Spanish, set CFG_DEFAULT_LANGUAGE to 'es'.

To translate your App into a language not translated in standard, for example in Portuguese:

1. Copy the INSTALL_DIR/engine/core/lang/locale_en.php english core translation script into the INSTALL_DIR/applications/default/app/lang/ folder,
2. Rename the copied locale_en.php script by changing the en filename suffix to the ISO 639-1 country code corresponding to your country, in this case to locale_pt.php.
3. Edit the new locale_pt.php script and translate the PHP constant values in Portuguese.
4. Edit the INSTALL_DIR/applications/default/app/config.php PHP script and change the value of the CFG_DEFAULT_LANGUAGE parameter from en to 'pt'.
5. Refresh your Web App in your web browser; the title, the footer, the user and profil management features are now translated in Portuguese.

It is also possible to translate a view of the application directly into several languages.
For example, if a view is originally named myview.php with text displayed in English, then it might be suffixed with its language code (eg myview_en.php).
This view once translated into Spanish will be named myview_es.php and the one translated into French will be named myview_fr.php.
Thus, the view corresponding to the language to be displayed for the application will be chosen automatically by ZnetDK.

Finally, the display of the application can be set to a specific language by reloading it with the ?lang=<iso code> parameter added to its URL.
For example, to display the application in Spanish: https://mydomain/myapp?lang=es.

See on the Code Snippets page an example of Multilingual application.

PHP Constants

Locale PHP Script: INSTALL_DIR/applications/default/app/lang/locale.php

The locale is used by ZnetDK to display dates and amounts formatted according to the user's language.

The locale can be set globally through the single LC_LOCALE_ALL PHP constant described below. However, this implies that the desired locale is installed on the web server.

Alternatively, the locale can be directly customized using the following PHP constants, independently of the locales installed on the web server: LC_LOCALE_DECIMAL_SEPARATOR, LC_LOCALE_THOUSANDS_SEPARATOR, LC_LOCALE_NUMBER_OF_DECIMALS, LC_LOCALE_CURRENCY_SYMBOL, LC_LOCALE_CURRENCY_SYMBOL_PRECEDE, LC_LOCALE_CURRENCY_SYMBOL_SEPARATE, LC_LOCALE_DATE_FORMAT, LC_LOCALE_CSV_SEPARATOR

PHP Constants

LC_LOCALE_ALL, LC_LOCALE_DECIMAL_SEPARATOR, LC_LOCALE_THOUSANDS_SEPARATOR, LC_LOCALE_NUMBER_OF_DECIMALS, LC_LOCALE_CURRENCY_SYMBOL, LC_LOCALE_CURRENCY_SYMBOL_PRECEDE, LC_LOCALE_CURRENCY_SYMBOL_SEPARATE, LC_LOCALE_DATE_FORMAT, LC_LOCALE_CSV_SEPARATOR

<?php
// ZnetDK version <= 2.7
define('LC_LOCALE_DATE_FORMAT', '%d-%m-%y');
// ZnetDK version >= 2.8
define('LC_LOCALE_DATE_FORMAT', 'd-m-y');

By default, a view is loaded only once on demand, is not removed from the DOM (Document Object Model) when it is hidden, and therefore is not reloaded when it is displayed again on subsequent times.

This behaviour can be changed via the following PHP constants.

PHP Constants

App configuration PHP Script: INSTALL_DIR/applications/default/app/config.php.

Pictures, documents and other files uploaded by users or generated by the Starter App can be stored within the INSTALL_DIR/applications/default/documents/ private directory whose absolute file path is accessible via the CFG_DOCUMENTS_DIR PHP constant described below.

PHP Constants

Controller actions can be exposed as Web Services.

The POST method should be used to call a Web Service. The GET method is reserved for downloading files.

The web service is authenticated through Basic Authentication. A dedicated user is generally declared in the application to call a web service.

For example, to execute the MyController::action_dostuff() controller action of the Application deployed at https://mydomain.com/mydir/, with the user account wsuser to authenticate, submit via the POST method the following URL:

See below for PHP constants to configure controller actions to expose as a web service.

PHP Constants

Apache configuration file: INSTALL_DIR/.htaccess.

According to the directory where ZnetDK for mobile is installed, the HTTP Error 403 (access forbidden) and HTTP error 404 (page not found) must be handled properly by adjusting the Apache Web Server ErrorDocument parameter.

Then, if users attempt to access a page that does not exist or to which access is denied, then they will be automatically redirected to the dedicated ZnetDK HTTP error page.

The view displayed in case of HTTP errors is INSTALL_DIR/engine/core/view/httperror.php.
This view can be customized after having copied it into the INSTALL_DIR/applications/default/app/view/ folder.

Configuration scenarios

CASE 1: App deployed directly at http://mydomain/

In this case, ZnetDK is directly installed in the root directory of your Apache web server.

For example, your web root directory is /var/www/html/ and so the file path of the .htaccess file shipped with ZnetDK is /var/www/html/.htaccess.
Here is below the path to specify for the ErrorDocument statement in the ZnetDK's .htaccess file.

CASE 2: App deployed at http://mydomain/mysubdirectory/

In this second case, ZnetDK is installed in a subdirectory of the root directory of your Apache web server.

For example, your web root directory is /var/www/html/, the subdirectory is named mysubdirectory/ and so the file path of the .htaccess file shipped with ZnetDK is /var/www/html/mysubdirectory/.htaccess.
Here is below the path to specify for the ErrorDocument statement in the ZnetDK's .htaccess file.

App configuration PHP Script: INSTALL_DIR/applications/default/app/config.php.

The ZnetDK 4 Mobile Starter Web application is natively configured to be a Progressive Web App.
A default service worker is started when loading the application.
The Starter Web App can be installed on devices with a web browser that supports A2HS feature like Chrome and Safari.

PHP Constants

App configuration PHP Script: INSTALL_DIR/applications/default/app/config.php.

Additionnal application settings are described in this section.

PHP Constants

 Constant CFG_DISPLAY_ERROR_DETAIL

 Constant CFG_EXEC_PHP_SCRIPT_AFTER_ACTION_DONE